🔧 Add gems and dependency and config Guard

Gemfile

@@ -2,3 +2,9 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in elasticsearch_reader.gemspec
 gemspec
+
+gem 'guard'
+gem 'guard-rspec'
+
+gem 'redcarpet'
+gem 'yard'

Guardfile

@@ -0,0 +1,18 @@
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { 'spec' }
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

README.md

@@ -2,6 +2,8 @@
 
 ElasticsearchReader is an ODM for Elasticsearch and query DSL in a OO style.
 
+## Why ElasticsearchReader?
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -28,6 +30,17 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 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).
 
+## TODO
+
+ - [ ] Configrations and settings
+ - [ ] Object mapper
+ - [ ] Relations
+ - [ ] Query DSL
+ - [ ] Pagination
+ - [ ] Embedding
+ - [ ] Elasticsearch Analysis
+ - [ ] Aggregations
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/adham90/elasticsearch_reader. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

elasticsearch_reader.gemspec

@@ -21,8 +21,16 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
+  spec.metadata['yard.run'] = 'yri'
 
   spec.add_development_dependency 'bundler', '~> 1.14'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '0.48.1'
+  spec.add_development_dependency 'rspec-its'
+  spec.add_development_dependency 'rspec-collection_matchers'
+  spec.add_development_dependency 'appraisal'
+
+  spec.add_dependency 'elasticsearch', '>= 5.0.0'
+  spec.add_dependency 'elasticsearch-dsl'
 end

spec/elasticsearch_reader_spec.rb

@@ -4,8 +4,4 @@
   it 'has a version number' do
     expect(ElasticsearchReader::VERSION).not_to be nil
   end
-
-  it 'does something useful' do
-    expect(false).to eq(true)
-  end
 end