Skip to content

Commit

Permalink
Travis Setup and README updates (#1)
Browse files Browse the repository at this point in the history
* Changed: Travis Build Fix #1

* Added: SimpleCov coverage report

* Changed: Bundler and ruby versions

* Updated: README.md

* Updated: README.md with build badges

* Updated: Fixed gemspec links

* Fixed: Prepend not working on ruby 2.3.0

* Fixed: Passing Badge
  • Loading branch information
vachhanihpavan authored Dec 23, 2019
1 parent b4fb31a commit 099e19e
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 23 deletions.
6 changes: 5 additions & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,21 @@
language: ruby
cache: bundler
rvm:
- 2.5.5
- 2.6.3
before_install: gem install bundler -v 2.1.2
before_install: gem install bundler -v 2.0.0

install:
# Get Redis
- git clone --depth=1 https://github.com/antirez/redis.git && cd redis && make && cd ..
# Get ReJSON
- git clone --depth=1 https://github.com/RedisLabsModules/ReJSON.git && cd ReJSON && make && cd ..
# Install dependency gems
- bundle install

before_script:
- ./redis/src/redis-server --loadmodule ReJSON/src/rejson.so &
- bundle install

script:
- bundle exec rspec
22 changes: 5 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# Rejson::Rb
# RedisJSON Ruby Client [![Build Status](https://travis-ci.com/vachhanihpavan/rejson-rb.svg?token=x85KXUqPs5qJik1EzpyW&branch=master)](https://travis-ci.com/vachhanihpavan/rejson-rb)

Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rejson/rb`. To experiment with that code, run `bin/console` for an interactive prompt.

TODO: Delete this and the text above, and describe your gem
rejson-rb is a package that allows storing, updating and querying objects as JSON documents in a [Redis](https://redis.io/) database that is extended with the [ReJSON](https://github.com/RedisJSON/RedisJSON) module. The package extends redis-rb's interface with ReJSON's API, and performs on-the-fly serialization/deserialization of objects to/from JSON.

## Installation

Expand All @@ -20,25 +18,15 @@ Or install it yourself as:

$ gem install rejson-rb

## Usage

TODO: Write usage instructions here

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rejson-rb. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/rejson-rb/blob/master/CODE_OF_CONDUCT.md).

Bug reports and pull requests are welcome on GitHub at https://github.com/vachhanihpavan/rejson-rb. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/vachhanihpavan/rejson-rb/blob/master/CODE_OF_CONDUCT.md).

For complete documentation about ReJSON's commands, refer to ReJSON's website.
## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

## Code of Conduct

Everyone interacting in the Rejson::Rb project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rejson-rb/blob/master/CODE_OF_CONDUCT.md).
Everyone interacting in the Rejson::Rb project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/vachhanihpavan/rejson-rb/blob/master/CODE_OF_CONDUCT.md).
9 changes: 4 additions & 5 deletions rejson-rb.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,13 @@ Gem::Specification.new do |spec|

spec.summary = "Redis JSON Ruby Adapter"
spec.description = "Redis JSON Ruby Adapter"
spec.homepage = "https://github.com"
spec.homepage = "https://github.com/vachhanihpavan/rejson-rb"
spec.license = "MIT"
spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")

spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"

spec.metadata["homepage_uri"] = spec.homepage
spec.metadata["source_code_uri"] = "https://github.com"
spec.metadata["changelog_uri"] = "https://github.com"
spec.metadata["source_code_uri"] = "https://github.com/vachhanihpavan/rejson-rb"
spec.metadata["changelog_uri"] = "https://github.com/vachhanihpavan/rejson-rb"

# Specify which files should be added to the gem when it is released.
# The `git ls-files -z` loads the files in the RubyGem that have been added into git.
Expand All @@ -33,4 +31,5 @@ Gem::Specification.new do |spec|
spec.add_runtime_dependency "json"
spec.add_development_dependency "bundler", "~> 2.0"
spec.add_development_dependency "rspec", "~> 3.0"
spec.add_development_dependency "simplecov"
end
2 changes: 2 additions & 0 deletions spec/spec_helper.rb
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# frozen_string_literal: true
require 'simplecov'
SimpleCov.start

require_relative "../lib/rejson"
# require "redis_rejson"
Expand Down

0 comments on commit 099e19e

Please sign in to comment.