ashikawa-core 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 69a85f6915e0b414287dc3307d02e085f84bfc82
-  data.tar.gz: e3c79577a4ac4d4a2ed35f7b9af0ad8c3a67e2d4
+  metadata.gz: 7ac637ffe2cc3b5cc3ed883347d703b51ba3ccb3
+  data.tar.gz: a1791745822da535b4a18448c9813551aa510dcd
 SHA512:
-  metadata.gz: aa06b6fd63584f04f87695bf84a9821fd34f7773dfad1321b0f4feaa84aadf97343dc9b789c49a6673ecbf26595eeec2ebfee801fe822606876d53e7fec96ad2
-  data.tar.gz: f37af4b66535e42206d44b7c2897e87a3579f8da027ba1defb450d85173279f79f88d21222e0c3c7a650151e5966d3eaad868d92300174e4935e3b24e0faa59d
+  metadata.gz: 8b4a80e54218ce219f0c125bec825cd0369c345dc1f7beb8b1e05cf4997700e385da13c43d8819dfb6ceebd75b3d5e9e76e7973528a31fd372b39cb6ca2200a2
+  data.tar.gz: ac70032a5665a804dc83185c34103a8b641b4f6263bce00ddae96761150cf1ae1dd4fec8fe0286121f05f986027d20c05372bb939e1f92e980d80c797d068844

data/.ruby-version

@@ -1 +1 @@
-ruby-2.0.0-p247
+ruby-2.1.1

data/.travis.yml

@@ -1,18 +1,18 @@
 language: ruby
+before_install:
+  - gem install bundler -v '= 1.5.1' # http://changelog.travis-ci.com/post/71633370723/mri-ruby-2-1-0-and-jruby-1-7-9-available
 before_script:
   - ./spec/setup/arangodb.sh
 rvm:
   - 1.9.3
   - 2.0.0
+  - 2.1.0
   - jruby-19mode
-  - jruby-head
-  - rbx-19mode
-  - ruby-head
+  - rbx-2.2.5
 env:
-  - ARANGODB_DISABLE_AUTHENTIFICATION=true VERSION=1.4.devel
-  - ARANGODB_DISABLE_AUTHENTIFICATION=false VERSION=1.4.devel
+  - ARANGODB_DISABLE_AUTHENTIFICATION=false VERSION=1.4
+  - ARANGODB_DISABLE_AUTHENTIFICATION=false VERSION=2.0
 matrix:
   allow_failures:
-    - rvm: ruby-head
-    - rvm: jruby-head
+    - rvm: 2.1.0
 script: "bundle exec rake ci"

data/CHANGELOG.md

@@ -1,3 +1,28 @@
+# Version 0.10
+
+**Codename: Sepia Tone Laboratory**
+
+* Support for ArangoDB 1.4 and 2.0
+* Big Refactoring Release
+    * Including significant refactoring of the test suite
+* Breaking change:
+    * `Document#hash` is now `Document#to_h`. This was a huge mistake before, sorry for that! #86
+* Bug Fixes:
+    * Crashes on Rubinius have been fixed – it's now supported #75
+* Allow the usage of both keys and IDs for `Collection#fetch` and `Collection#replace` #77
+* Logging
+    * Don't spam the log files #88
+* Use Faraday Middleware and middleware included in Faraday instead of custom tailored middleware #92
+* The branching model has been changed: There's no development branch anymore
+    * This was confusing to both users and contributors #79
+* Other adjustments:
+    * Most classes are now 100% mutation tested via mutant #37
+* New Contributors
+    * Nikita Vasiliev (@sharpyfox)
+    * Dirk Breuer (@railsbros-dirk)
+
+*Codename in honor of Lifeformed.*
+
 # Version 0.9
 
 **Codename: Weramur**

data/CONTRIBUTING.md

@@ -2,12 +2,12 @@
 
 When you want to write code for the project, please follow these guidelines:
 
-1. **Claim** the ticket: Tell us that you want to work on a certain ticket, we will assign it to you (We don't want two people to work on the same thing ;) )
-2. **Fork** your feature branch from the `development` branch (not the `master` branch)
+1. **Claim** the ticket: Tell us that you want to work on a certain ticket, we will assign it to you (We don't want two people to work on the same thing :wink:)
+2. **Fork** your feature branch from the `master` branch
 3. Write an **acceptance test**: Describe what you want to do (our acceptance 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 `bundle exec rake ci` (you need to have ArangoDB running for that) that everything is fine and send the pull request to the `development` branch :)
+5. Write **documentation** for it
+6. Check with `bundle exec rake ci` (you need to have ArangoDB running for that) that everything is fine and send the pull request to the `development` branch :smiley:
 
 ## Setup
 

data/Gemfile.devtools

@@ -1,24 +1,28 @@
 # encoding: utf-8
 
 group :development do
-  gem 'rake',  '~> 10.1.0'
-  gem 'rspec', '~> 2.14.1'
-  gem 'yard',  '~> 0.8.7'
+  gem 'rake',       '~> 10.1.0'
+  gem 'rspec',      '~> 2.14.1'
+  gem 'rspec-core', '~> 2.14.8'
+  gem 'yard',       '~> 0.8.7'
+
+  platform :rbx do
+    gem 'rubysl-singleton', '~> 2.0.0'
+  end
 end
 
 group :yard do
-  gem 'kramdown', '~> 1.2.0'
+  gem 'kramdown', '~> 1.3.2'
 end
 
 group :guard do
-  gem 'guard',         '~> 1.8.1'
-  gem 'guard-bundler', '~> 1.0.0'
-  gem 'guard-rspec',   '~> 3.0.2'
-  gem 'guard-rubocop', '~> 0.2.0'
-  gem 'guard-mutant',  '~> 0.0.1'
+  gem 'guard',         '~> 2.4.0'
+  gem 'guard-bundler', '~> 2.0.0'
+  gem 'guard-rspec',   '~> 4.2.6'
+  gem 'guard-rubocop', '~> 1.0.2'
 
   # file system change event handling
-  gem 'listen',     '~> 1.3.0'
+  gem 'listen',     '~> 2.5.0'
   gem 'rb-fchange', '~> 0.0.6', require: false
   gem 'rb-fsevent', '~> 0.9.3', require: false
   gem 'rb-inotify', '~> 0.9.0', require: false
@@ -30,18 +34,30 @@ group :guard do
 end
 
 group :metrics do
-  gem 'coveralls', '~> 0.6.7'
+  gem 'coveralls', '~> 0.7.0'
   gem 'flay',      '~> 2.4.0'
-  gem 'flog',      '~> 4.1.1'
+  gem 'flog',      '~> 4.2.0'
   gem 'reek',      '~> 1.3.2'
-  gem 'rubocop',   '~> 0.13.0'
-  gem 'simplecov', '~> 0.7.1'
-  gem 'yardstick', '~> 0.9.7', git: 'https://github.com/dkubb/yardstick.git'
+  gem 'rubocop',   '~> 0.18.1'
+  gem 'simplecov', '~> 0.8.2'
+  gem 'yardstick', '~> 0.9.9'
+
+  platforms :mri do
+    gem 'mutant',       '~> 0.5.3'
+    gem 'mutant-rspec', '~> 0.5.3'
+  end
 
   platforms :ruby_19, :ruby_20 do
-    gem 'mutant', git: 'https://github.com/mbj/mutant.git'
     gem 'yard-spellcheck', '~> 0.1.5'
   end
+
+  platform :rbx do
+    gem 'json',               '~> 1.8.1'
+    gem 'racc',               '~> 1.4'
+    gem 'rubysl-logger',      '~> 2.0.0'
+    gem 'rubysl-open-uri',    '~> 2.0.0'
+    gem 'rubysl-prettyprint', '~> 2.0.2'
+  end
 end
 
 group :benchmarks do

data/README.md

@@ -3,21 +3,19 @@
 | Project         | Ashikawa::Core
 |:----------------|:--------------------------------------------------
 | Homepage        | http://triagens.github.io/ashikawa-core/
-| Documentation   | http://www.rubydoc.info/github/triAGENS/ashikawa-core
+| Documentation   | [RubyDoc](http://www.rubydoc.info/gems/ashikawa-core)
 | CI              | [![Build Status](https://secure.travis-ci.org/triAGENS/ashikawa-core.png?branch=master)](http://travis-ci.org/triAGENS/ashikawa-core)
-| Code Metrics    | [![Code Climate](https://codeclimate.com/github/triAGENS/ashikawa-core.png)](https://codeclimate.com/github/triAGENS/ashikawa-core) [![Coverage Status](https://coveralls.io/repos/triAGENS/ashikawa-core/badge.png?branch=coverall)](https://coveralls.io/r/triAGENS/ashikawa-core)
+| Code Metrics    | [![Code Climate](https://codeclimate.com/github/triAGENS/ashikawa-core.png)](https://codeclimate.com/github/triAGENS/ashikawa-core)
 | Gem Version     | [![Gem Version](https://badge.fury.io/rb/ashikawa-core.png)](http://badge.fury.io/rb/ashikawa-core)
 | Dependencies    | [![Dependency Status](https://gemnasium.com/triAGENS/ashikawa-core.png)](https://gemnasium.com/triAGENS/ashikawa-core)
 
-Ashikawa Core is a Wrapper around the ArangoDB Rest API. It provides low level access and is intended to be used in ArangoDB ODMs and other projects related to the database. It is always working with the stable version of ArangoDB, this is currently version **1.4**. If you want to access an ArangoDB instance running version **1.3** to version [0.8](https://github.com/triAGENS/ashikawa-core/tree/0.8) of this gem (or just update :wink:).
+Ashikawa Core is a Wrapper around the ArangoDB Rest API. It provides low level access and is intended to be used in ArangoDB ODMs and other projects related to the database. It is always working with the stable version of ArangoDB, this is currently version **1.4** and the preview of **2.0**.
 
 All tests run on Travis CI for the following versions of Ruby:
 
-* MRI 1.9.3 and 2.0.0
-* Rubinius 1.9 mode
-* JRuby 1.9 mode
-
-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).
+* MRI 1.9.3, 2.0.0 and 2.1.0
+* Rubinius 2.2.5
+* JRuby 1.7.9 in 1.9 mode
 
 Please note that the [`master`](https://github.com/triAGENS/ashikawa-core) branch is always the stable version released on Ruby Gems and documented on [RDoc](http://www.rubydoc.info/github/triAGENS/ashikawa-core). If you want the most recent version, please refer to the [`development`](https://github.com/triAGENS/ashikawa-core/tree/development) branch.
 
@@ -30,7 +28,7 @@ gem install ashikawa-core
 or, when using bundler:
 
 ```ruby
-gem "ashikawa-core", "~> 0.9"
+gem "ashikawa-core", "~> 0.10"
 ```
 
 ## How to Setup a Connection?
@@ -48,7 +46,7 @@ If you want to access the `my_db` database of your ArangoDB instance (and not th
 ```ruby
 database = Ashikawa::Core::Database.new do |config|
   config.url = "http://localhost:8529/_db/my_db"
-  config.user = "lebowski"
+  config.username = "lebowski"
   config.password = "i<3bowling"
 end
 ```
@@ -68,7 +66,7 @@ database = Ashikawa::Core::Database.new do |config|
 end
 ```
 
-For a detailed description on how to use Ashikawa::Core please refer to the [documentation](http://rdoc.info/github/triAGENS/ashikawa-core/master/frames). An example:
+For a detailed description on how to use Ashikawa::Core please refer to the [documentation](http://rdoc.info/gems/ashikawa-core/frames). An example:
 
 ```ruby
 database["my_collection"] # => Returns the collection my_collection – creates it, if it doesn't exist

data/Rakefile

@@ -7,3 +7,6 @@ require 'rspec/core/rake_task'
 Devtools.init_rake_tasks
 
 import('./tasks/adjustments.rake')
+
+# Default task is running everything except mutant
+task default: %w[ spec ci:metrics ]

data/ashikawa-core.gemspec

@@ -12,8 +12,8 @@ Gem::Specification.new do |gem|
   gem.description = "Ashikawa Core is a wrapper around the ArangoDB REST API. It provides low level access and is intended to be used in ArangoDB ODMs and other tools."
   gem.license = "Apache License 2.0"
 
-  gem.required_ruby_version = '>= 1.9.2'
-  gem.requirements << "ArangoDB, v1.4"
+  gem.required_ruby_version = '>= 1.9.3'
+  gem.requirements << "ArangoDB, v1.4 or v2.0"
 
   gem.rubyforge_project = "ashikawa-core"
 
@@ -22,8 +22,10 @@ Gem::Specification.new do |gem|
   gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   gem.require_paths = ["lib"]
 
-  gem.add_dependency "faraday", "~> 0.8.6"
-  gem.add_dependency "json", "~> 1.8.0"
+  gem.add_dependency "faraday", "~> 0.8.8"
+  gem.add_dependency "faraday_middleware", "~> 0.9.0"
+  gem.add_dependency "json", "~> 1.8.1"
   gem.add_dependency "null_logger", "~> 0.0.1"
-  gem.add_dependency "equalizer", "~> 0.0.5"
+  gem.add_dependency "equalizer", "~> 0.0.8"
+  gem.add_dependency "rubysl-base64" if RUBY_ENGINE == "rbx"
 end

data/config/flay.yml

@@ -1,3 +1,3 @@
 ---
-threshold: 12
-total_score: 343
+threshold: 11
+total_score: 275

data/config/flog.yml

@@ -1,2 +1,3 @@
 ---
-threshold: 12.8
+threshold: 13.4
+enabled_platforms: [mri-2.0.0]

data/config/mutant.yml

@@ -1,3 +1,16 @@
 ---
 name: ashikawa-core
-namespace: Ashikawa::Core
+namespace:
+# - Ashikawa::Core::Collection
+- Ashikawa::Core::Configuration
+# - Ashikawa::Core::Connection
+# - Ashikawa::Core::Cursor
+# - Ashikawa::Core::Database
+- Ashikawa::Core::Document
+- Ashikawa::Core::Edge
+- Ashikawa::Core::Figure
+- Ashikawa::Core::Index
+- Ashikawa::Core::KeyOptions
+# - Ashikawa::Core::Query
+- Ashikawa::Core::Status
+- Ashikawa::Core::Transaction

data/config/reek.yml

@@ -18,8 +18,7 @@ DataClump:
   min_clump_size: 2
 DuplicateMethodCall:
   enabled: true
-  exclude:
-  - Ashikawa::Core::ResponsePreprocessor#handle_status
+  exclude: []
   max_calls: 1
   allow_calls: []
 FeatureEnvy:
@@ -62,7 +61,10 @@ TooManyMethods:
   max_methods: 15
 TooManyStatements:
   enabled: true
-  exclude: []
+  exclude:
+  - Ashikawa::Core::Connection#initialize
+  - Ashikawa::Core::ErrorResponse#on_complete
+  - Ashikawa::Core::Figure#initialize
   max_statements: 5
 UncommunicativeMethodName:
   enabled: true
@@ -91,7 +93,7 @@ UncommunicativeVariableName:
   enabled: true
   exclude: []
   reject:
-  - !ruby/regexp /^.$/
+  - !ruby/regexp /^[^_]$/
   - !ruby/regexp /[0-9]$/
   - !ruby/regexp /[A-Z]/
   accept: []
@@ -102,3 +104,6 @@ UtilityFunction:
   enabled: false
   exclude: []
   max_helper_calls: 0
+PrimaDonnaMethod:
+  enabled: false
+  exclude: []

data/config/rubocop.yml

@@ -5,7 +5,7 @@ AllCops:
     - 'Guardfile'
     - 'Rakefile'
   Excludes:
-    - 'spec/setup/**/*'
+    - !ruby/regexp /spec\/setup/
 
 # Avoid parameter lists longer than five parameters.
 ParameterLists:
@@ -24,15 +24,6 @@ CollectionMethods:
     find:     'detect'
     find_all: 'select'
 
-# Do not force public/protected/private keyword to be indented at the same
-# level as the def keyword. My personal preference is to outdent these keywords
-# because I think when scanning code it makes it easier to identify the
-# sections of code and visually separate them. When the keyword is at the same
-# level I think it sort of blends in with the def keywords and makes it harder
-# to scan the code and see where the sections are.
-AccessControl:
-  Enabled: true
-
 HashSyntax:
   Enabled: true
 
@@ -56,9 +47,6 @@ AlignParameters:
 Blocks:
   Enabled: false
 
-SymbolName:
-  Enabled: false
-
 NumericLiterals:
   Enabled: true
 
@@ -86,7 +74,7 @@ Alias:
   Enabled: true
 
 Loop:
-  Enabled: true
+  Enabled: false
 
 # Do not agree at all
 AndOr:
@@ -95,3 +83,15 @@ AndOr:
 # This is done by YARD Stick
 Documentation:
   Enabled: false
+
+# Braces can be really, really useful for clarity
+BracesAroundHashParameters:
+  Enabled: false
+
+# I prefer raise over fail
+SignalException:
+  EnforcedStyle: only_raise
+
+ClassLength:
+  CountComments: false
+  Max: 140

data/lib/ashikawa-core/collection.rb

@@ -411,18 +411,18 @@ module Ashikawa
       # Add an index to the collection
       #
       # @param [Symbol] type specify the type of the index, for example `:hash`
-      # @option opts [Array<Symbol>] on fields on which to apply the index
-      # @option opts [Boolean] unique Should the index be unique? Default is false
+      # @option options [Array<Symbol>] on fields on which to apply the index
+      # @option options [Boolean] unique Should the index be unique? Default is false
       # @return Index
       # @api public
       # @example Add a hash-index to the fields :name and :profession of a collection
       #   people = database['people']
       #   people.add_index(:hash, :on => [:name, :profession])
-      def add_index(type, opts)
-        unique = opts[:unique] || false
+      def add_index(type, options)
+        unique = options.fetch(:unique, false)
         response = send_request("index?collection=#{@id}", post: {
           'type' => type.to_s,
-          'fields' => opts[:on].map { |field| field.to_s },
+          'fields' => options.fetch(:on).map { |field| field.to_s },
           'unique' => unique
         })
 
@@ -540,7 +540,11 @@ module Ashikawa
       # @return [Hash] parsed JSON response from the server
       # @api private
       def send_request_for_content_key(document_key, opts = {})
-        send_request("#{@content_type}/#{@id}/#{document_key}", opts)
+        if document_key.to_s.include? '/'
+          send_request("#{@content_type}/#{document_key}", opts)
+        else
+          send_request("#{@content_type}/#{@id}/#{document_key}", opts)
+        end
       end
 
       # Send a request for the content of this collection

data/lib/ashikawa-core/configuration.rb

@@ -40,7 +40,7 @@ module Ashikawa
       # @return Connection
       def connection
         @connection = @connection || setup_new_connection
-        @connection.authenticate_with(username: username, password: password) if username && password
+        @connection.authenticate_with(username, password) if username && password
         @connection
       end
 
@@ -55,10 +55,15 @@ module Ashikawa
       # @api private
       def setup_new_connection
         raise(ArgumentError, 'Please provide either an url or a connection to setup the database') if url.nil?
-        Ashikawa::Core::Connection.new(url, {
-          logger: logger,
-          adapter: adapter
-        })
+
+        Connection.new(url, connection_options)
+      end
+
+      def connection_options
+        opts = {}
+        opts[:logger] = logger if logger
+        opts[:adapter] = adapter if adapter
+        opts
       end
     end
   end