ashikawa-core 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7ac637ffe2cc3b5cc3ed883347d703b51ba3ccb3
-  data.tar.gz: a1791745822da535b4a18448c9813551aa510dcd
+  metadata.gz: 243fdb95bc1ad7691bc5129b1dce1f85ad929792
+  data.tar.gz: e5bc4fda8b7d97e6bf90cf8570227afaff1b9128
 SHA512:
-  metadata.gz: 8b4a80e54218ce219f0c125bec825cd0369c345dc1f7beb8b1e05cf4997700e385da13c43d8819dfb6ceebd75b3d5e9e76e7973528a31fd372b39cb6ca2200a2
-  data.tar.gz: ac70032a5665a804dc83185c34103a8b641b4f6263bce00ddae96761150cf1ae1dd4fec8fe0286121f05f986027d20c05372bb939e1f92e980d80c797d068844
+  metadata.gz: 31d2dcb8dc2b0ad4c431181cac8cc22daf224215791406dca9d81e4f78f472187e156a4b9e7f36a38a1bc4f9d9f5dfc7bfc806a2c24def3265eefb1d455e6362
+  data.tar.gz: d0bc42d3059d787ea3747c279c0c522d4bcb4558cae5978529e33945726ba3f8f7260c90a447f6a97700f7d19b449d9bd1da03a805426b87ac0223c90cd2ce0d

data/.gitignore

@@ -10,3 +10,4 @@
 /coverage
 /.rbx
 /tmp
+/cache/*

data/{config/rubocop.yml → .hound.yml}

@@ -1,10 +1,10 @@
 AllCops:
-  Includes:
+  Include:
     - '../**/*.rake'
     - 'Gemfile'
     - 'Guardfile'
     - 'Rakefile'
-  Excludes:
+  Exclude:
     - !ruby/regexp /spec\/setup/
 
 # Avoid parameter lists longer than five parameters.
@@ -37,6 +37,9 @@ LineLength:
   Enabled: true
   Max: 120
 
+DotPosition:
+  EnforcedStyle: 'leading'
+
 SpaceInsideHashLiteralBraces:
   Enabled: true
 
@@ -95,3 +98,15 @@ SignalException:
 ClassLength:
   CountComments: false
   Max: 140
+
+# The suggested style does not match the common ruby way of aligning the content of a hash
+IndentHash:
+  Enabled: false
+
+# This cop seems to not work correctly. Also we don't agree with it.
+FileName:
+  Enabled: false
+
+# Double negations are extremely useful
+DoubleNegation:
+  Enabled: false

data/.ruby-version

@@ -1 +1 @@
-ruby-2.1.1
+ruby-2.1.2

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
-  - rbx-2.2.5
+  - 2.1.2
+  - jruby-1.7.12
+  - rbx-2.2.6
 env:
-  - ARANGODB_DISABLE_AUTHENTIFICATION=false VERSION=1.4
   - ARANGODB_DISABLE_AUTHENTIFICATION=false VERSION=2.0
 matrix:
   allow_failures:
     - rvm: 2.1.0
 script: "bundle exec rake ci"
+addons:
+  code_climate:
+    repo_token: 4d49e70568a106875f85f2918698df75118b4a83af20ad57317b10f5fc40d5e0

data/CHANGELOG.md

@@ -1,3 +1,25 @@
+# Version 0.11
+
+**Codename: R3C0NF1GUR3D**
+
+* Only supports ArangoDB 2.0 officially from now on.
+* **Breaking Change:** Collection#truncate! is now Collection#truncate
+* New feature: Create and Drop Databases – and get their name and truncate all collections at once #103 
+* New feature: Allow to pass `bind_vars` to the execution of AQL #107 #113 
+* Dependency Update: Faraday and Faraday Middleware #111 
+* Documentation Improvements #95 
+* README improvements #100 #102 #106 
+* Development Setup Changes:
+    * Removed Devtools entirely #93 
+    * Updated to RSpec 3.0 #94 #112 
+    * Use HoundCI as our code style checker #105 
+    * Use Inch for documentation checking #93 
+    * Bring all development dependencies up to date #111 
+* New Contributors
+    * Mike Williamson (@sleepycat)
+
+*Codename in honor of Daft Punk.*
+
 # Version 0.10
 
 **Codename: Sepia Tone Laboratory**

data/Gemfile

@@ -1,9 +1,8 @@
 # -*- encoding : utf-8 -*-
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in ashikawa-core.gemspec
 gemspec
 
-gem 'devtools', git: 'https://github.com/rom-rb/devtools.git'
-
-eval_gemfile 'Gemfile.devtools'
+%w( core mocks expectations support its ).each do |name|
+  gem "rspec-#{name}", github: "rspec/rspec-#{name}"
+end

data/Guardfile

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

data/README.md

@@ -4,20 +4,18 @@
 |:----------------|:--------------------------------------------------
 | Homepage        | http://triagens.github.io/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)
-| 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)
+| CI              | [![Build Status](http://img.shields.io/travis/triAGENS/ashikawa-core.svg)](http://travis-ci.org/triAGENS/ashikawa-core)
+| Code Metrics    | [![Code Climate](http://img.shields.io/codeclimate/github/triAGENS/ashikawa-core.svg)](https://codeclimate.com/github/triAGENS/ashikawa-core) [![Code Climate Coverage](http://img.shields.io/codeclimate/coverage/github/triAGENS/ashikawa-core.svg)](https://codeclimate.com/github/triAGENS/ashikawa-core)
+| Gem Version     | [![Gem Version](http://img.shields.io/gem/v/ashikawa-core.svg)](http://rubygems.org/gems/ashikawa-core)
+| Dependencies    | [![Dependency Status](http://img.shields.io/gemnasium/triAGENS/ashikawa-core.svg)](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** and the preview of **2.0**.
+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 **2.0**.
 
 All tests run on Travis CI for the following versions of Ruby:
 
-* 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.
+* MRI 1.9.3, 2.0.0 and 2.1.2
+* Rubinius 2.2.6
+* JRuby 1.7.12
 
 ## How to install it?
 
@@ -28,7 +26,7 @@ gem install ashikawa-core
 or, when using bundler:
 
 ```ruby
-gem "ashikawa-core", "~> 0.10"
+gem "ashikawa-core", "~> 0.11"
 ```
 
 ## How to Setup a Connection?
@@ -87,3 +85,6 @@ If you want to contribute to the project, see CONTRIBUTING.md for details. It co
 * Markus Schirp ([@mbj](https://github.com/mbj)): Contributor
 * Ettore Berardi ([@ettomatic](https://github.com/ettomatic)): Contributor
 * Samuel Richardson ([@Rodeoclash](https://github.com/Rodeoclash)): Contributor
+* Nikita Vasiliev ([@sharpyfox](https://github.com/sharpyfox)): Contributor
+* Dirk Breuer ([@railsbros-dirk](https://github.com/railsbros-dirk)): Contributor
+* Mike Williamson ([@sleepycat](https://github.com/sleepycat)): Contributor

data/Rakefile

@@ -1,12 +1,58 @@
-#!/usr/bin/env rake
 # -*- encoding : utf-8 -*-
-require 'devtools'
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'yard/rake/yardoc_task'
+require 'inch/rake'
+require 'reek/rake/task'
 
-Devtools.init_rake_tasks
+desc 'Run all specs'
+task spec: ['spec:unit', 'spec:acceptance']
 
-import('./tasks/adjustments.rake')
+namespace :spec do
+  desc 'Run unit specs'
+  RSpec::Core::RakeTask.new(:unit) do |task|
+    task.pattern = 'spec/unit/**/*_spec.rb'
+  end
 
-# Default task is running everything except mutant
-task default: %w[ spec ci:metrics ]
+  desc 'Run acceptance specs – requires running instance of ArangoDB'
+  RSpec::Core::RakeTask.new(:acceptance) do |task|
+    task.pattern = 'spec/acceptance/**/*_spec.rb'
+  end
+end
+
+YARD::Rake::YardocTask.new(:doc)
+
+namespace :metrics do
+  Inch::Rake::Suggest.new do |t|
+    t.args << '--pedantic'
+  end
+
+  Reek::Rake::Task.new do |t|
+    t.fail_on_error = true
+    t.config_files = 'config/reek.yml'
+  end
+
+  desc 'Run mutant to check for mutation coverage'
+  task :mutant do
+    require 'mutant'
+    require 'mutant-rspec'
+
+    namespaces = YAML.load_file('config/mutant.yml').map { |n| "::#{n}*" }
+    arguments  = %w(--include lib --require ashikawa-core --use rspec).concat(namespaces)
+    status = Mutant::CLI.run(arguments)
+    exit 'Mutant task is not successful' if status.nonzero?
+  end
+end
+
+desc 'Start a REPL with guacamole loaded (not the Rails part)'
+task :console do
+  require 'bundler/setup'
+
+  require 'pry'
+  require 'ashikawa-core'
+  ARGV.clear
+  Pry.start
+end
+
+task default: :spec
+task ci: ['spec', 'metrics:reek']

data/ashikawa-core.gemspec

@@ -1,31 +1,54 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "ashikawa-core/version"
+$:.push File.expand_path('../lib', __FILE__)
+require 'ashikawa-core/version'
 
 Gem::Specification.new do |gem|
-  gem.name        = "ashikawa-core"
+  gem.name        = 'ashikawa-core'
   gem.version     = Ashikawa::Core::VERSION
-  gem.authors     = ["moonglum"]
-  gem.email       = ["me@moonglum.net"]
-  gem.homepage    = "http://triagens.github.com/ashikawa-core"
-  gem.summary     = "Ashikawa Core is a wrapper around the ArangoDB REST API"
-  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.authors     = ['moonglum']
+  gem.email       = ['me@moonglum.net']
+  gem.homepage    = 'http://triagens.github.com/ashikawa-core'
+  gem.summary     = 'Ashikawa Core is a wrapper around the ArangoDB REST API'
+  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.3'
-  gem.requirements << "ArangoDB, v1.4 or v2.0"
+  gem.requirements << 'ArangoDB, v2.0'
 
-  gem.rubyforge_project = "ashikawa-core"
+  gem.rubyforge_project = 'ashikawa-core'
 
   gem.files         = `git ls-files`.split("\n")
   gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  gem.require_paths = ["lib"]
-
-  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.8"
-  gem.add_dependency "rubysl-base64" if RUBY_ENGINE == "rbx"
+  gem.require_paths = ['lib']
+
+  # Runtime Dependencies
+  gem.add_dependency 'faraday', '~> 0.9.0'
+  gem.add_dependency 'faraday_middleware', '~> 0.9.1'
+  gem.add_dependency 'json', '~> 1.8.1'
+  gem.add_dependency 'null_logger', '~> 0.0.1'
+  gem.add_dependency 'equalizer', '~> 0.0.8'
+
+  # Development Dependencies
+  gem.add_development_dependency 'rake', '~> 10.3.1'
+  gem.add_development_dependency 'rspec', '~> 3.0.0.beta2'
+  gem.add_development_dependency 'rspec-its', '~> 1.0.1'
+  gem.add_development_dependency 'codeclimate-test-reporter', '~> 0.3.0'
+  gem.add_development_dependency 'yard', '~> 0.8.7.4'
+  gem.add_development_dependency 'inch', '~> 0.4.5'
+  gem.add_development_dependency 'reek', '~> 1.3.7'
+  gem.add_development_dependency 'mutant', '~> 0.5.12'
+  gem.add_development_dependency 'mutant-rspec', '~> 0.5.3'
+  gem.add_development_dependency 'pry', '~> 0.9.12.6'
+  gem.add_development_dependency 'guard', '~> 2.6.1'
+  # gem.add_development_dependency 'guard-rspec', '~> 4.2.8'
+  gem.add_development_dependency 'guard-bundler', '~> 2.0.0'
+
+  # Rubinius specific dependencies
+  if RUBY_ENGINE == 'rbx'
+    gem.add_dependency 'rubysl-base64'
+    gem.add_dependency 'rubysl-singleton'
+  end
+
+  # JRuby specific dependencies
 end

data/config/mutant.yml

@@ -1,6 +1,4 @@
 ---
-name: ashikawa-core
-namespace:
 # - Ashikawa::Core::Collection
 - Ashikawa::Core::Configuration
 # - Ashikawa::Core::Connection
@@ -9,7 +7,7 @@ namespace:
 - Ashikawa::Core::Document
 - Ashikawa::Core::Edge
 - Ashikawa::Core::Figure
-- Ashikawa::Core::Index
+# - Ashikawa::Core::Index
 - Ashikawa::Core::KeyOptions
 # - Ashikawa::Core::Query
 - Ashikawa::Core::Status

data/config/reek.yml

@@ -45,6 +45,7 @@ NilCheck:
   enabled: true
   exclude:
   - Ashikawa::Core::Configuration#setup_new_connection
+  - Ashikawa::Core::Connection#database_name
 RepeatedConditional:
   enabled: true
   exclude:
@@ -58,6 +59,7 @@ TooManyMethods:
   enabled: true
   exclude:
   - Ashikawa::Core::Collection
+  - Ashikawa::Core::Database
   max_methods: 15
 TooManyStatements:
   enabled: true
@@ -65,7 +67,7 @@ TooManyStatements:
   - Ashikawa::Core::Connection#initialize
   - Ashikawa::Core::ErrorResponse#on_complete
   - Ashikawa::Core::Figure#initialize
-  max_statements: 5
+  max_statements: 6
 UncommunicativeMethodName:
   enabled: true
   exclude: []

data/lib/ashikawa-core/collection.rb

@@ -18,11 +18,13 @@ module Ashikawa
 
       include Equalizer.new(:id, :name, :content_type, :database)
 
+      # ArangoDB's collections contain either only documents or only edges
       CONTENT_TYPES = {
         2 => :document,
         3 => :edge
       }
 
+      # Map the content types to the classes from Ashikawa
       CONTENT_CLASS = {
         document: Document,
         edge: Edge
@@ -337,14 +339,14 @@ module Ashikawa
       #     'code' => 200
       #   }
       #   collection = Ashikawa::Core::Collection.new(database, raw_collection)
-      #   collection.truncate!
-      def truncate!
+      #   collection.truncate
+      def truncate
         send_command_to_server(:truncate)
       end
 
       # Fetch a certain document by its key
       #
-      # @param [Integer] document_key the key of the document
+      # @param [Fixnum] document_key the key of the document
       # @raise [DocumentNotFoundException] If the requested document was not found
       # @return Document
       # @api public
@@ -357,7 +359,7 @@ module Ashikawa
 
       # Fetch a certain document by its key, return nil if the document does not exist
       #
-      # @param [Integer] document_key the id of the document
+      # @param [Fixnum] document_key the id of the document
       # @return Document
       # @api public
       # @example Fetch the document with the key 12345
@@ -370,7 +372,7 @@ module Ashikawa
 
       # Replace a document by its key
       #
-      # @param [Integer] document_key the key of the document
+      # @param [Fixnum] document_key the key of the document
       # @param [Hash] raw_document the data you want to replace it with
       # @return [Hash] parsed JSON response from the server
       # @api public
@@ -431,7 +433,7 @@ module Ashikawa
 
       # Get an index by ID
       #
-      # @param [Integer] id
+      # @param [Fixnum] id
       # @return Index
       # @api public
       # @example Get an Index by its ID
@@ -535,7 +537,7 @@ module Ashikawa
 
       # Send a request for the content with the given key
       #
-      # @param [Integer] document_id The id of the document
+      # @param [Fixnum] document_key The id of the document
       # @param [Hash] opts The options for the request
       # @return [Hash] parsed JSON response from the server
       # @api private

data/lib/ashikawa-core/configuration.rb

@@ -39,7 +39,7 @@ module Ashikawa
       # @api private
       # @return Connection
       def connection
-        @connection = @connection || setup_new_connection
+        @connection ||= setup_new_connection
         @connection.authenticate_with(username, password) if username && password
         @connection
       end

data/lib/ashikawa-core/connection.rb

@@ -77,6 +77,22 @@ module Ashikawa
         end
       end
 
+      # Get the name of the current database
+      #
+      # @api public
+      # @example Get the name of the database
+      #   connection = Connection.new('http://localhost:8529/_db/ashikawa')
+      #   connection.database_name # => 'ashikawa'
+      def database_name
+        database_regexp = %r{_db/(?<db_name>\w+)/_api}
+        result = @connection.url_prefix.to_s.match(database_regexp)
+        if result.nil?
+          '_system'
+        else
+          result['db_name']
+        end
+      end
+
       # Sends a request to a given path returning the parsed result
       # @note prepends the api_string automatically
       #
@@ -96,6 +112,21 @@ module Ashikawa
         raise Ashikawa::Core::JsonError
       end
 
+      # Sends a request to a given path without the database suffix returning the parsed result
+      # @note prepends the api_string automatically
+      #
+      # @param [string] path the path you wish to send a request to.
+      # @option params [hash] :post post data in case you want to send a post request.
+      # @return [hash] parsed json response from the server
+      # @api public
+      # @example get request
+      #   connection.send_request('/collection/new_collection')
+      # @example post request
+      #   connection.send_request('/collection/new_collection', :post => { :name => 'new_collection' })
+      def send_request_without_database_suffix(path, params = {})
+        send_request(uri_without_database_suffix(path), params)
+      end
+
       # Checks if authentication for this Connection is active or not
       #
       # @return [Boolean]
@@ -113,6 +144,7 @@ module Ashikawa
       #
       # @param [String] username
       # @param [String] password
+      # @return [String] Basic Auth info (Base 64 of username:password)
       # @api private
       def authenticate_with(username, password)
         @authentication = @connection.basic_auth(username, password)
@@ -120,6 +152,17 @@ module Ashikawa
 
       private
 
+      # Build an URI without the database suffix
+      #
+      # @param [String] additional_path The path you want to access
+      # @return [URI] The resulting URI
+      # @api private
+      def uri_without_database_suffix(additional_path = '')
+        uri = @connection.url_prefix
+        base_uri = [uri.scheme, '://', uri.host, ':', uri.port].join
+        [base_uri, '_api', additional_path].join('/')
+      end
+
       # Return the HTTP Verb for the given parameters
       #
       # @param [Hash] params The params given to the method