ashikawa-core 0.5.1 → 0.6.0

data/.gitignore

@@ -1,10 +1,12 @@
 .DS_Store
-.yardoc
-doc
-*.gem
-.bundle
-Gemfile.lock
-pkg/*
-report/*
-coverage
-.rbx
+/.yardoc
+/doc
+/*.gem
+/.bundle
+/Gemfile.lock
+/pkg/*
+/report/*
+/measurements/*
+/coverage
+/.rbx
+/tmp

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--format progress
+--profile
+--order random

data/.travis.yml

@@ -2,14 +2,19 @@ language: ruby
 before_script:
   - ./spec/setup/arangodb.sh
 rvm:
+  - 1.8.7
   - 1.9.2
   - 1.9.3
-  - rbx-19mode
+  - 2.0.0
+  - jruby-18mode
   - jruby-19mode
-  - ruby-head
   - jruby-head
+  - rbx-18mode
+  - rbx-19mode
+  - ree
+  - ruby-head
 matrix:
   allow_failures:
     - rvm: ruby-head
     - rvm: jruby-head
-script: "rake ci"
+script: "bundle exec rake ci"

data/CONTRIBUTING.md

@@ -7,7 +7,7 @@ When you want to write code for the project, please follow these guidelines:
 3. Write an acceptance test: Describe what you want to do (our integration tests touch the database)
 4. Implement it: Write a unit test, check that it fails, make the test pass – repeat (our unit tests don't touch the database)
 5. Write documentation for it.
-6. Check with `rake` that everything is fine and send the pull request to the `development` branch :)
+6. Check with `bundle exec rake` that everything is fine and send the pull request to the `development` branch :)
 
 ## How to get started developing
 
@@ -17,7 +17,7 @@ Getting started is easy, just follow these steps.
 
 * Clone the project.
 * `cd` into the folder and run `bundle` 
-* `rake` and see all tests passing (you need to have ArangoDB installed for that)
+* `bundle exec rake` and see all tests passing (you need to have ArangoDB installed for that)
 * Happy coding!
 
 ### Detailed description
@@ -28,13 +28,13 @@ We encourage you to use [rvm](https://rvm.io/). If you do so, a gemset for the p
 
 Change into the project directory. Run `bundle` to get all dependencies (do a `gem install bundler` before if you don't have bundler installed).
 
-Now you can run `rake` to see all tests passing (hopefully). Happy coding!
+Now you can run `bundle exec rake` to see all tests passing (hopefully). Happy coding!
 
-You can also start up yard for documentation: `rake yard:server`
+You can also start up yard for documentation: `bundle exec rake yard:server`
 
 ### Guard
 
-Guard is a tool for comfortable development. If you want to use it for development, you have to first start an instance of ArangoDB and then start guard with `guard`. This will:
+Guard is a tool for comfortable development. If you want to use it for development, you have to first start an instance of ArangoDB and then start guard with `bundle exec guard`. This will:
 
 * Run a documentation server on `http://localhost:8808`
 * Run `bundle` whenever you change the dependencies

data/Gemfile

@@ -1,4 +1,8 @@
-source "http://rubygems.org"
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in ashikawa-core.gemspec
 gemspec
+
+gem 'devtools', :git => 'https://github.com/datamapper/devtools.git'
+
+eval File.read('Gemfile.devtools')

data/Gemfile.devtools

@@ -0,0 +1,65 @@
+# encoding: utf-8
+
+group :development do
+  gem 'rake',  '~> 10.0.3'
+  gem 'rspec', '~> 2.12.0'
+  gem 'yard',  '~> 0.8.4.1'
+end
+
+group :yard do
+  gem 'redcarpet', '~> 2.2.2', :platforms => [ :mri, :rbx ]
+end
+
+group :guard do
+  gem 'guard',         '~> 1.6.2'
+  gem 'guard-bundler', '~> 1.0.0'
+  gem 'guard-rspec',   '~> 2.3.3'
+
+  # file system change event handling
+  gem 'rb-fchange', '~> 0.0.6', :require => false
+  gem 'rb-fsevent', '~> 0.9.3', :require => false
+  gem 'rb-inotify', '~> 0.9.0', :require => false
+
+  # Remove this one https://github.com/guard/listen/pull/78 is released
+  gem 'listen', '~> 0.7.2', :git => 'https://github.com/guard/listen.git'
+
+  # notification handling
+  gem 'libnotify',               '~> 0.8.0', :require => false
+  gem 'rb-notifu',               '~> 0.0.4', :require => false
+  gem 'terminal-notifier-guard', '~> 1.5.3', :require => false
+end
+
+group :metrics do
+  gem 'flay',      '~> 1.4.3'
+  gem 'flog',      '~> 2.5.3'
+  gem 'reek',      '~> 1.2.13', :git => 'https://github.com/troessner/reek.git', :ref => 'ef77fcecaa21c9ebcbe4d9a79d41b0e70196bf18'
+  gem 'roodi',     '~> 2.2.0'
+  gem 'yardstick', '~> 0.9.2'
+
+  platforms :ruby_18, :ruby_19 do
+    # this indirectly depends on ffi which does not build on ruby-head
+    gem 'yard-spellcheck', '~> 0.1.5'
+  end
+
+  platforms :mri_19, :rbx do
+#    gem 'mutant', '~> 0.2.16'
+  end
+
+  platforms :mri_19 do
+    gem 'simplecov', '~> 0.7.1'
+  end
+
+  platforms :rbx do
+    gem 'pelusa', '~> 0.2.2'
+  end
+end
+
+group :benchmarks do
+  gem 'rbench', '~> 0.2.3'
+end
+
+platform :jruby do
+  group :jruby do
+    gem 'jruby-openssl', '~> 0.8.2'
+  end
+end

data/Guardfile

@@ -2,17 +2,7 @@ guard 'bundler' do
   watch(/^.+\.gemspec/)
 end
 
-guard 'yard' do
-  watch(%r{lib/.+\.rb})
-end
-
 guard 'rspec', :spec_paths => "spec/unit" do
-  watch(%r{lib/.+\.rb})
-  watch(%r{spec/.+\.rb})
-end
-
-guard 'rspec', :spec_paths => "spec/acceptance" do
-  watch(%r{lib/.+\.rb})
   watch(%r{spec/.+\.rb})
+  watch(%r{lib/ashikawa-core/(.+)\.rb$}) { |m| "spec/unit/#{m[1]}_spec.rb" }
 end
-

data/README.md

@@ -1,20 +1,22 @@
 # Ashikawa Core
 
+[![Gem Version](https://badge.fury.io/rb/ashikawa-core.png)](http://badge.fury.io/rb/ashikawa-core)
 [![Build Status](https://secure.travis-ci.org/triAGENS/ashikawa-core.png?branch=master)](http://travis-ci.org/triAGENS/ashikawa-core)
-[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/triAGENS/ashikawa-core)
 [![Dependency Status](https://gemnasium.com/triAGENS/ashikawa-core.png)](https://gemnasium.com/triAGENS/ashikawa-core)
+[![Code Climate](https://codeclimate.com/github/triAGENS/ashikawa-core.png)](https://codeclimate.com/github/triAGENS/ashikawa-core)
 
-Ashikawa Core is a Wrapper around the ArangoDB Rest API. It provides low level access and will be used in different ArangoDB ODMs.
+Ashikawa Core is a Wrapper around the ArangoDB Rest API. It provides low level access and will be used in different ArangoDB ODMs and other projects related to the database. It is always working with the stable version of ArangoDB, this is currently version **1.1.2**.
 
 All tests run on Travis CI for the following versions of Ruby:
 
-* MRI 1.9.2 and 1.9.3
-* Rubinius 1.9 mode
-* JRuby 1.9 mode
+* MRI 1.8.7, 1.9.2 and 1.9.3
+* Rubinius 1.8 and 1.9 mode
+* JRuby 1.8 and 1.9 mode
+* REE
 
-We also run on JRuby and MRI Head. MRI-head is currently not passing, because some dependencies are not compatible.
+We also run on JRuby and MRI Head, but they are allowed failures (Please see [Travis](http://travis-ci.org/triAGENS/ashikawa-core) for their build status).
 
-Please note that the `master` branch is always the stable version released on Ruby Gems (*This is actually a lie, but we are currently converting to this model ;) The next release will implement this*). If you want the most recent version, please refer to the `development` branch.
+Please note that the `master` branch is always the stable version released on Ruby Gems and documented on RDoc. If you want the most recent version, please refer to the `development` branch.
 
 ## How to use it
 
@@ -34,4 +36,8 @@ If you find a bug in this gem, please report it on [our tracker](https://github.
 
 # Contributing
 
-If you want to contribute to the project, see CONTRIBUTING.md for details. It contains information on our process and how to set up everything.
+If you want to contribute to the project, see CONTRIBUTING.md for details. It contains information on our process and how to set up everything. The following people have contributed to this project:
+
+* Lucas Dohmen (@moonglum): Developer
+* Tobias Eilert (@EinLama): Contributor
+* Markus Schirp (@mbj): Contributor

data/Rakefile

@@ -1,106 +1,8 @@
 #!/usr/bin/env rake
-require "bundler/gem_tasks"
-require "rspec"
-require "rspec/core/rake_task"
-require "roodi"
-require "roodi_task"
-# require 'yardstick/rake/measurement'
-# require 'yardstick/rake/verify'
+require 'devtools'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
+Devtools.init
 
-namespace :spec do
-  desc "Run the acceptance tests. Requires ArangoDB to be running."
-  RSpec::Core::RakeTask.new(:acceptance_with_running_arangodb) do |spec|
-    spec.pattern = "spec/acceptance/*_spec.rb"
-  end
-
-  desc "Run the acceptance tests. Requires ArangoDB."
-  RSpec::Core::RakeTask.new(:acceptance) do |spec|
-    spec.rspec_opts = "--require acceptance/arango_helper.rb"
-    spec.pattern = "spec/acceptance/*_spec.rb"
-  end
-
-  desc "Run the authentication acceptance tests. Requires ArangoDB."
-  RSpec::Core::RakeTask.new(:acceptance_auth) do |spec|
-    spec.rspec_opts = "--require acceptance_auth/arango_helper.rb"
-    spec.pattern = "spec/acceptance_auth/*_spec.rb"
-  end
-
-  desc "Run the unit tests"
-  RSpec::Core::RakeTask.new(:unit) do |spec|
-    spec.pattern = "spec/unit/*_spec.rb"
-  end
-
-  desc "Run all tests. Requires ArangoDB"
-  task :all => [:acceptance, :unit]
-end
-
-desc "check if gems are up to date"
-task :dependencies do
-  dependency_status = `bundle outdated`
-  if dependency_status.include? "up to date"
-    puts "Dependencies up to date."
-  else
-    puts dependency_status
-    exit(1)
-  end
-end
-
-namespace :yard do
-  # Yardstick::Rake::Measurement.new(:report) do |measurement|
-  #   measurement.output = 'report/measurement.txt'
-  # end
-
-  # Yardstick::Rake::Verify.new(:verify) do |verify|
-  #   verify.threshold = 100
-  # end
-
-  desc "generate the documentation"
-  task :generate do
-    `yard`
-  end
-
-  desc "start the documentation server on port 8808"
-  task :server do
-    `yard server --reload`
-  end
-
-  desc "get statistics on the yard documentation"
-  task :stats do
-    `yard stats`
-  end
-end
-
-namespace :metrics do
-  metric_tasks = []
-
-  begin
-    require 'cane/rake_task'
-
-    desc "Run cane to check quality metrics"
-    Cane::RakeTask.new(:cane) do |cane|
-      cane.abc_max = 10
-      cane.style_measure = 140
-      cane.style_glob = "{app,lib}/**/*.rb"
-    end
-
-    metric_tasks << :cane
-  rescue LoadError
-    warn "cane not available, quality task not provided."
-  end
-
-  RoodiTask.new do |roodi|
-    roodi.patterns = %w(lib/**/*.rb spec/**/*.rb)
-  end
-  metric_tasks << :roodi
-
-  task :all => metric_tasks
-end
-
-desc "Run Unit Tests - no ArangoDB required"
-# task :ci => ["spec:unit", "yard:verify"]
-task :ci => ["spec:unit", "spec:acceptance_with_running_arangodb", "metrics:all"]
-
-desc "Run all tests and verify documentation - ArangoDB required"
-# task :default => ["spec:all", "yard:verify"]
-task :default => ["spec:all", "metrics:all"]
+import("./tasks/adjustments.rake")

data/ashikawa-core.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |gem|
   gem.description = "Ashikawa Core is a wrapper around the ArangoDB REST API. It provides low level access and will be used in different ArangoDB ODMs."
 
   gem.required_ruby_version = '>= 1.9.2'
-  gem.requirements << "ArangoDB, v1.0 alpha or greater"
+  gem.requirements << "ArangoDB, v1.1.2"
 
   gem.rubyforge_project = "ashikawa-core"
 
@@ -23,34 +23,8 @@ Gem::Specification.new do |gem|
 
   # Runtime Dependencies
   gem.add_dependency "rest-client", "~> 1.6.7"
-
-  # Runtime Dependencies (JRuby only)
-  if defined? PLATFORM and PLATFORM == 'java'
-    gem.add_dependency "json", "~> 1.7.5"
-    gem.add_dependency "jruby-openssl", "~> 0.7.7"
-  else
-    # RedCarpet is not compatible with JRuby
-    # It is only needed to generate the YARD Documentation
-    gem.add_development_dependency "redcarpet", "~> 2.2.2"
-  end
+  gem.add_dependency "json", "~> 1.7.7"
 
   # Development Dependencies
-  gem.add_development_dependency "rake", "~> 0.9.2.2"
-  gem.add_development_dependency "rspec", "~> 2.11.0"
-  gem.add_development_dependency "yard", "~> 0.8.3"
-  gem.add_development_dependency "webmock", "~> 1.9.0"
-  # gem.add_development_dependency "yardstick", "~> 0.6.0"
-  gem.add_development_dependency "simplecov", "~> 0.7.1"
-  gem.add_development_dependency "cane", "~> 2.4.0"
-  gem.add_development_dependency "roodi1.9", "~> 2.0.1"
-
-  # Do not update to version 3, it is currently not compatible with roodi1.9
-  # see grsmv/roodi1.9#1
-  gem.add_development_dependency "ruby_parser", "~> 2.3.1"
-
-  gem.add_development_dependency "guard", "~> 1.5.3"
-  gem.add_development_dependency "guard-rspec", "~> 2.1.1"
-  gem.add_development_dependency "guard-bundler", "~> 1.0.0"
-  gem.add_development_dependency "guard-yard", "~> 2.0.1"
-  gem.add_development_dependency "rb-fsevent", "~> 0.9.2"
+  gem.add_development_dependency "webmock", "~> 1.9.3"
 end

data/config/flay.yml

@@ -0,0 +1,3 @@
+---
+threshold: 18
+total_score: 250

data/config/flog.yml

@@ -0,0 +1,2 @@
+---
+threshold: 23.0

data/config/mutant.yml

@@ -0,0 +1,3 @@
+---
+name: ashikawa-core
+namespace: Ashikawa::Core

data/config/roodi.yml

@@ -0,0 +1,18 @@
+AbcMetricMethodCheck:            { score: 15.0 }
+AssignmentInConditionalCheck:    { }
+CaseMissingElseCheck:            { }
+ClassLineCountCheck:             { line_count: 500 }
+ClassNameCheck:
+  pattern: !ruby/regexp /^[A-Z][a-zA-Z0-9]*$/
+ClassVariableCheck:              { }
+CyclomaticComplexityBlockCheck:  { complexity: 1 }
+CyclomaticComplexityMethodCheck: { complexity: 5 }
+EmptyRescueBodyCheck:            { }
+ForLoopCheck:                    { }
+MethodLineCountCheck:            { line_count: 10 }
+MethodNameCheck:
+  pattern: !ruby/regexp /^[_a-z<>=\[\]|+-\/\*`]+[_a-z0-9_<>=~@\[\]]*[=!\?]?$/
+ModuleLineCountCheck:            { line_count: 500 }
+ModuleNameCheck:
+  pattern: !ruby/regexp /^[A-Z][a-zA-Z0-9]*$/
+ParameterNumberCheck:            { parameter_count: 5 }

data/config/site.reek

@@ -0,0 +1,95 @@
+---
+UncommunicativeParameterName:
+  accept: []
+  exclude: []
+  enabled: false
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+LargeClass:
+  max_methods: 10
+  exclude:
+  - Ashikawa::Core::Query
+  - Ashikawa::Core::Collection
+  enabled: true
+  max_instance_variables: 5
+UncommunicativeMethodName:
+  accept: []
+  exclude: []
+  enabled: true
+  reject:
+  - !ruby/regexp /^[a-z]$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+LongParameterList:
+  max_params: 3
+  exclude:
+  - Ashikawa::Core::Query#wrapped_request
+  enabled: true
+  overrides: {}
+FeatureEnvy:
+  exclude: []
+  enabled: false
+ClassVariable:
+  exclude: []
+  enabled: true
+BooleanParameter:
+  exclude: []
+  enabled: true
+IrresponsibleModule:
+  exclude: []
+  enabled: true
+UncommunicativeModuleName:
+  accept: []
+  exclude: []
+  enabled: true
+  reject: []
+NestedIterators:
+  ignore_iterators: []
+  exclude: []
+  enabled: true
+  max_allowed_nesting: 2
+LongMethod:
+  max_statements: 8
+  exclude: []
+  enabled: true
+Duplication:
+  allow_calls: []
+  exclude:
+  - Ashikawa::Core::Document#initialize
+  enabled: true
+  max_calls: 1
+UtilityFunction:
+  max_helper_calls: 0
+  exclude: []
+  enabled: false
+Attribute:
+  exclude: []
+  enabled: false
+UncommunicativeVariableName:
+  accept: []
+  exclude: []
+  enabled: true
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+SimulatedPolymorphism:
+  exclude:
+  - Ashikawa::Core::Query
+  enabled: true
+  max_ifs: 1
+DataClump:
+  exclude:
+  - Ashikawa::Core::Query
+  enabled: true
+  max_copies: 2
+  min_clump_size: 2
+ControlCouple:
+  exclude: []
+  enabled: true
+LongYieldList:
+  max_params: 1
+  exclude: []
+  enabled: true