curio 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bc28163d1bb46f19b67859128f7aa5919dbb3db0
+  data.tar.gz: 15db1a1eb06af28ab4b140580dadcf3dcf217718
+SHA512:
+  metadata.gz: 673e78456916956fdb249bebab246af4cea5256d8182ec61bc1427b8dfc887ad13336caf728e7bebcc446518cc899e3267be835767f87db9ff2b7fdcfe079d56
+  data.tar.gz: 226735b61807e97bfeb135e379b2b42c1012870f42fa37a23f57b42c5d002dabc38eb59293ebf1199da3a0e4b276f063a74c9576a04792a0ec392be3ac15536b

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rubocop.yml

@@ -0,0 +1,74 @@
+AllCops:
+  Exclude:
+    - bin/**/*
+    - vendor/**/*
+
+Encoding:
+  Enabled: true
+
+Documentation:
+  Enabled: false
+
+LineLength:
+  Max: 72
+
+# Class
+ClassLength:
+  Max: 80
+
+EmptyLinesAroundAccessModifier:
+  Enabled: false
+
+AccessModifierIndentation:
+  EnforcedStyle: indent
+
+# Error
+RaiseArgs:
+  EnforcedStyle: exploded
+
+SignalException:
+  EnforcedStyle: semantic
+
+# Method
+MethodLength:
+  Max: 10
+
+SingleLineMethods:
+  AllowIfMethodIsEmpty: false
+
+CollectionMethods:
+  PreferredMethods:
+    collect: 'map'
+    collect!: 'map!'
+    reduce: 'inject'
+    detect: 'find'
+    find_all: 'select'
+
+# Parameter
+ParameterLists:
+  Max: 3
+  CountKeywordArgs: true
+
+BracesAroundHashParameters:
+  Enabled: false
+  EnforcedStyle: braces
+
+# Block
+BlockNesting:
+  Max: 3
+
+# Brackets
+SpaceInsideBrackets:
+  Enabled: true
+
+# Hash
+IndentHash:
+  EnforcedStyle: consistent
+
+SpaceInsideHashLiteralBraces:
+  EnforcedStyle: space
+  EnforcedStyleForEmptyBraces: space
+
+# String
+StringLiterals:
+  EnforcedStyle: single_quotes

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in curio.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Terje Larsen
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# Curio
+
+A module to ease creation of collections and enumerable maps
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'curio'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install curio
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/curio/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+require 'rubocop/rake_task'
+
+Rubocop::RakeTask.new
+
+task default: :test
+task test: 'test:all'
+task ci: %w(rubocop test:all)
+
+namespace :test do
+  desc 'Run all tests'
+  Rake::TestTask.new :all do |t|
+    t.test_files = Rake::FileList['test/*_test.rb']
+  end
+
+  desc 'Run unit tests'
+  Rake::TestTask.new :unit do |t|
+    t.test_files = Rake::FileList['test/unit_test.rb']
+  end
+
+  desc 'Run integration tests'
+  Rake::TestTask.new :integration do |t|
+    t.test_files = Rake::FileList['test/integration_test.rb']
+  end
+end

data/curio.gemspec

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+require File.expand_path('../lib/curio/version', __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'curio'
+  spec.version       = Curio::VERSION
+  spec.authors       = ['Terje Larsen']
+  spec.email         = ['terlar@gmail.com']
+  spec.description   = 'Mixin for enumerable maps'
+  spec.summary       = spec.description
+  spec.homepage      = 'https://github.com/terlar/curio'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(/^test\//)
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rubocop'
+end

data/lib/curio/version.rb

@@ -0,0 +1,5 @@
+# encoding: utf-8
+
+class Curio < Module
+  VERSION = '0.1.0'
+end

data/lib/curio.rb

@@ -0,0 +1,186 @@
+# encoding: utf-8
+
+require 'curio/version'
+
+# A mixin to define enumerable maps
+class Curio < Module
+  # Error raised when fetch cannot find an item with key
+  class NotFoundError < KeyError
+    def initialize(key)
+      @key = key
+      super "Item not found in collection with key: #{key}"
+    end
+  end
+
+  # Initialize a collection object with given key and type
+  #
+  # :key will be used to determine which method to call on items to get
+  # their unique identifier when adding them to the collection.
+  #
+  # :type will be used to determine how to coerce the input when calling
+  # methods on the collection.
+  #
+  # @param [Symbol] key
+  # @param [Class] type
+  #
+  # @return [undefined]
+  #
+  # @api private
+  def initialize(key, type = String)
+    @key, @type = key, type
+
+    define_key_method
+    define_coerce_key_method
+
+    freeze
+  end
+
+  private
+  # Hook called when module is included
+  #
+  # @param [Class|Module] descendant
+  #
+  # @return [undefined]
+  #
+  # @api private
+  def included(descendant)
+    super
+
+    descendant.module_eval do
+      include Enumerable
+      include Methods
+    end
+  end
+
+  # Define #key_method based on @key
+  #
+  # @return [undefined]
+  #
+  # @api private
+  def define_key_method
+    key = @key
+    define_method :key_method do
+      key
+    end
+  end
+
+  # Define #coerce_key based on @type
+  #
+  # @return [undefined]
+  #
+  # @api private
+  def define_coerce_key_method
+    type = @type
+    define_method :coerce_key do |value|
+      case type.to_s
+      when 'String'  then "#{value}"
+      when 'Symbol'  then :"#{value}"
+      when 'Integer' then "#{value}".to_i
+      else value
+      end
+    end
+  end
+
+  # The collection methods
+  module Methods
+    extend Forwardable
+
+    # Iterate over each item in the collection
+    #
+    # @yield [object]
+    #
+    # @return [Enumerator]
+    #
+    # @api public
+    def_delegators :values, :each
+
+    # Last item in the collection
+    #
+    # @return [object]
+    #
+    # @api public
+    def_delegators :values, :last
+
+    # Setup the map and call parent initializer
+    #
+    # @return [undefined]
+    #
+    # @api private
+    def initialize(*)
+      @map = { }
+      super
+    end
+
+    # Get all the items in collection
+    #
+    # @return [Array]
+    #
+    # @api public
+    def values
+      @map.values
+    end
+    alias_method :all, :values
+
+    # Add an item to the collection
+    #
+    # @param [object] item
+    #
+    # @return [self]
+    #
+    # @api public
+    def <<(item)
+      key = coerce_key item.send(key_method)
+      @map[key] = item
+      self
+    end
+
+    # Fetch an item from the collection
+    #
+    # @yield [undefined]
+    #
+    # @param [undefined] key
+    # @param [undefined] default
+    #
+    # @return [object]
+    #
+    # @api public
+    def fetch(key, *args, &block)
+      args.unshift coerce_key(key)
+      @map.fetch(*args, &block)
+    rescue KeyError
+      raise NotFoundError, key
+    end
+
+    # Get an item from the collection
+    #
+    # @param [undefined] key
+    #
+    # @return [object]
+    #
+    # @api public
+    def [](key)
+      fetch key, nil
+    end
+
+    # Check if collection has an item with specified key
+    #
+    # @param [undefined] key
+    #
+    # @return [Boolean]
+    #
+    # @api public
+    def key?(key)
+      @map.key? coerce_key(key)
+    end
+    alias_method :has?, :key?
+
+    # Returns a hash representation of the collection
+    #
+    # @return [Hash]
+    #
+    # @api public
+    def to_h
+      @map
+    end
+  end
+end

data/test/integration_test.rb

@@ -0,0 +1,95 @@
+# encoding: utf-8
+
+require_relative 'test_helper'
+
+class IntegrationTest < MiniTest::Unit::TestCase
+  class Collection
+    include Curio.new(:id)
+  end
+
+  Item = Struct.new(:id)
+
+  attr_reader :collection
+
+  def setup
+    @collection = Collection.new
+  end
+
+  def test_enumerable_behavior
+    assert_kind_of Enumerable, collection
+    assert_instance_of Enumerator, collection.each
+  end
+
+  def test_retrieving_last_item
+    item1 = Item.new 1
+    item2 = Item.new 2
+    collection << item1 << item2
+
+    assert_equal item2, collection.last
+  end
+
+  def test_retriving_all_items
+    item1 = Item.new 1
+    item2 = Item.new 2
+    collection << item1 << item2
+
+    assert_equal [item1, item2], collection.all
+    assert_equal [item1, item2], collection.values
+  end
+
+  def test_retrieving_item
+    item = Item.new 'a'
+    collection << item
+
+    found = collection['a']
+    assert_equal item, found
+
+    found = collection.fetch 'a'
+    assert_equal item, found
+  end
+
+  def test_retrieving_unknown_item
+    found = collection['a']
+    assert_equal nil, found
+
+    assert_raises Curio::NotFoundError do
+      collection.fetch 'a'
+    end
+
+    found = collection.fetch 'a', 'bang'
+    assert_equal 'bang', found
+
+    found = collection.fetch('a') { 'bang' }
+    assert_equal 'bang', found
+  end
+
+  def test_adding_an_item
+    item = Item.new 1
+
+    assert_equal 0, collection.count
+    collection << item
+    assert_includes collection, item
+    assert_equal 1, collection.count
+  end
+
+  def test_item_is_known
+    item = Item.new 'a'
+    collection << item
+
+    assert collection.key? 'a'
+    assert collection.has? 'a'
+    refute collection.key? 'b'
+    refute collection.has? 'b'
+  end
+
+  def test_hash_representation
+    item1 = Item.new 'a'
+    item2 = Item.new 'b'
+    collection << item1 << item2
+
+    assert_equal({
+      'a' => item1,
+      'b' => item2
+    }, collection.to_h)
+  end
+end

data/test/test_helper.rb

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

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: curio
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Terje Larsen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rubocop
+  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'
+description: Mixin for enumerable maps
+email:
+- terlar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- curio.gemspec
+- lib/curio.rb
+- lib/curio/version.rb
+- test/integration_test.rb
+- test/test_helper.rb
+homepage: https://github.com/terlar/curio
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Mixin for enumerable maps
+test_files:
+- test/integration_test.rb
+- test/test_helper.rb