curio 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c463ca337476e67d29b326574fc74a24d6d59db7
-  data.tar.gz: 27f5fc7a322dc4856df2978073fd8fb5c26afeaa
+  metadata.gz: 3deec75594c85a9537d56bf024173def85d503ae
+  data.tar.gz: a299bfbdf527d20373cdbe3d6770a1e63cb735c9
 SHA512:
-  metadata.gz: dd25cca619fef69396c93a0baa7815f3748cf9e95d6c173b29519bd1fafbcdec5c5fde1a6d1435327abd4cde37bba1b5ef665cc2330ef04df678cbeee7522190
-  data.tar.gz: a284eea87ad452f86bbcafd2eb909bc39877bb96ac71be8acfadb040c3507aebcc9629b6a3991aa43848a6ddb516d70950173ef4ea6b38b33fd8c9589000707d
+  metadata.gz: 229f0809fd860285d25f0a69766615d10f51d521c1b7a6b93755e974f0d9659d503474bdd43b2168a17f52e706b1b566c7bd1b0f90a1d84063dd91b4758159a8
+  data.tar.gz: ae8f2e8563bc95149350c336bd95d9c512dff8c0eaf3bf859dc6c1e6103e36228b236b2de8c42ccf365d8b5494ed00f2facdefb06da6864565a46e7e0b977b7a

data/.travis.yml

@@ -1,14 +1,18 @@
 language: ruby
+sudo: false
+cache: bundler
+script:
+  - bundle exec rake
 rvm:
-  - 1.9.3
   - 2.0.0
-  - 2.1.0
-  - 2.2.2
-  - jruby-19mode
-  - rbx-2
-before_install:
-  - gem update --system
-  - gem update bundler
-install: 'bundle install'
-script: 'bundle exec rake'
-cache: bundler
+  - 2.1.10
+  - 2.2.5
+  - 2.3.1
+  - jruby-9.1.5.0
+  - rbx-3.60
+env:
+  global:
+    - JRUBY_OPTS='--dev -J-Xmx1024M'
+matrix:
+  allow_failures:
+    - rvm: rbx-3.60

data/Rakefile

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'bundler/setup'
 require 'bundler/gem_tasks'
 
@@ -8,7 +6,7 @@ require 'rubocop/rake_task'
 
 RuboCop::RakeTask.new
 
-task default: %w(rubocop test)
+task default: %w(test rubocop)
 task test: 'test:all'
 
 namespace :test do

data/curio.gemspec

@@ -1,4 +1,3 @@
-# encoding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'curio/version'
@@ -8,20 +7,22 @@ Gem::Specification.new do |spec|
   spec.version       = Curio::VERSION
   spec.authors       = ['Terje Larsen']
   spec.email         = ['terlar@gmail.com']
+  spec.license       = 'MIT'
+
   spec.summary       = 'Mixin for enumerable maps'
   spec.description   = spec.summary
   spec.homepage      = 'https://github.com/terlar/curio'
-  spec.license       = 'MIT'
 
-  spec.files            = `git ls-files`.split($RS)
+  spec.files            = `git ls-files -z`.split("\x0")
   spec.test_files       = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths    = %w(lib)
   spec.extra_rdoc_files = %w(LICENSE README.md)
 
-  spec.required_ruby_version = '>= 1.9.3'
+  spec.required_ruby_version = '>= 2.0.0'
 
+  spec.add_development_dependency 'pry'
   spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'minitest', '~> 5.8'
-  spec.add_development_dependency 'rubocop', '~> 0.35'
+  spec.add_development_dependency 'rake', '~> 11.0'
+  spec.add_development_dependency 'minitest', '~> 5.9'
+  spec.add_development_dependency 'rubocop', '~> 0.45'
 end

data/lib/curio.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'curio/version'
 
 require 'forwardable'
@@ -14,6 +12,8 @@ class Curio < Module
     end
   end
 
+  ConstraintError = Class.new(TypeError)
+
   # Initialize a collection object with given key and type
   #
   # :key will be used to determine which method to call on items to get
@@ -28,12 +28,16 @@ class Curio < Module
   # @return [undefined]
   #
   # @api private
-  def initialize(key, type = String)
+  def initialize(key, type = String, opts = { }.freeze)
     @key = key
     @type = type
+    @hooks = []
+
+    add_auto_increment_hook if opts[:auto_increment]
 
     define_key_method
     define_coerce_key_method
+    define_hooks_method
 
     freeze
   end
@@ -55,6 +59,38 @@ class Curio < Module
     end
   end
 
+  # Add auto increment hook.
+  #
+  # This adds a hook that sets the item key to the next integer based on
+  # the collection count if no item key is available.
+  #
+  # @return [undefined]
+  #
+  # @api private
+  def add_auto_increment_hook
+    unless @type == Integer
+      fail ConstraintError,
+           'auto-increment requires a key type of Integer'
+    end
+
+    @hooks << lambda do |collection, item|
+      return unless item.send(collection.key_method).nil?
+      item.send(:"#{collection.key_method}=", collection.count + 1)
+    end
+  end
+
+  # Define #hooks based on @hooks
+  #
+  # @return [Array]
+  #
+  # @api private
+  def define_hooks_method
+    hooks = @hooks
+    define_method :hooks do
+      hooks
+    end
+  end
+
   # Define #key_method based on @key
   #
   # @return [undefined]
@@ -76,9 +112,9 @@ class Curio < Module
     type = @type
     define_method :coerce_key do |value|
       case type.to_s
-      when 'String'  then "#{value}"
+      when 'String'  then value.to_s
       when 'Symbol'  then :"#{value}"
-      when 'Integer' then "#{value}".to_i
+      when 'Integer' then value.to_i
       else value
       end
     end
@@ -122,7 +158,7 @@ class Curio < Module
     def values
       @map.values
     end
-    alias_method :all, :values
+    alias all values
 
     # Add an item to the collection
     #
@@ -132,11 +168,12 @@ class Curio < Module
     #
     # @api public
     def add(item)
+      call_add_hooks item
       key = coerce_key item.send(key_method)
       @map[key.freeze] = item
       self
     end
-    alias_method :<<, :add
+    alias << add
 
     # Fetch an item from the collection
     #
@@ -176,7 +213,7 @@ class Curio < Module
     def key?(key)
       @map.key? coerce_key(key)
     end
-    alias_method :has?, :key?
+    alias has? key?
 
     # Returns a hash representation of the collection
     #
@@ -208,5 +245,17 @@ class Curio < Module
       @map.freeze
       super
     end
+
+    private
+
+    # Run all attached hooks
+    #
+    # Currently there is only the hook for auto increment if the
+    # collection was configured to use this.
+    #
+    # @api private
+    def call_add_hooks(item)
+      hooks.each { |hook| hook.call(self, item) }
+    end
   end
 end

data/lib/curio/version.rb

@@ -1,6 +1,4 @@
-# encoding: utf-8
-
 # Version
 class Curio < Module
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'.freeze
 end

data/test/auto_increment_test.rb

@@ -0,0 +1,50 @@
+require_relative 'test_helper'
+
+class AutoIncrementTest < Minitest::Test
+  class Collection
+    include Curio.new(:id, Integer, auto_increment: true)
+  end
+
+  Item = Struct.new(:id)
+
+  attr_reader :collection
+
+  def setup
+    @collection = Collection.new
+  end
+
+  def test_auto_increment_sets_item_key
+    item1 = Item.new
+    item2 = Item.new
+    collection << item1 << item2
+
+    assert_equal 1, item1.id
+    assert_equal 2, item2.id
+  end
+
+  def test_auto_increment_only_activates_with_missing_item_key
+    item1 = Item.new 5
+    item2 = Item.new
+    collection << item1 << item2
+
+    assert_equal 5, item1.id
+    assert_equal 2, item2.id
+  end
+
+  def test_auto_increment_items_can_be_fetched
+    item1 = Item.new
+    item2 = Item.new
+    collection << item1 << item2
+
+    assert_equal item1, collection[1]
+    assert_equal item2, collection[2]
+  end
+
+  def test_auto_increment_with_non_integer_raises_contstraint_error
+    assert_raises Curio::ConstraintError do
+      Class.new do
+        include Curio.new(:id, String, auto_increment: true)
+      end
+    end
+  end
+end

data/test/integration_test.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require_relative 'test_helper'
 
 # rubocop: disable ClassLength
@@ -38,7 +36,7 @@ class IntegrationTest < Minitest::Test
     assert_equal [item1, item2], collection.values
   end
 
-  def test_retrieving_item
+  def test_retrieving_an_item
     item = Item.new 'a'
     collection << item
 

data/test/test_helper.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'bundler/setup'
 require 'curio'
 require 'minitest/autorun'

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: curio
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Terje Larsen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-04 00:00:00.000000000 Z
+date: 2016-11-27 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -30,42 +44,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.8'
+        version: '5.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.8'
+        version: '5.9'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.35'
+        version: '0.45'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.35'
+        version: '0.45'
 description: Mixin for enumerable maps
 email:
 - terlar@gmail.com
@@ -85,6 +99,7 @@ files:
 - curio.gemspec
 - lib/curio.rb
 - lib/curio/version.rb
+- test/auto_increment_test.rb
 - test/integration_test.rb
 - test/test_helper.rb
 homepage: https://github.com/terlar/curio
@@ -99,7 +114,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -107,10 +122,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Mixin for enumerable maps
 test_files:
+- test/auto_increment_test.rb
 - test/integration_test.rb
 - test/test_helper.rb