hamstar 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6834ded7d8ce8c335b09b7c063611dc7a08ee9e2
+  data.tar.gz: 23e93acaa517ad80aecc7defac3c92abacc2e58a
+SHA512:
+  metadata.gz: 20440b52f938840a7e474e399e2af48f373af8f570253308b957ba9cc29afc5e786f122b81ab08440f984228a7c24c62eed4f33f2e860cdb5036036568e2dead
+  data.tar.gz: ab66aaedd99211d99418038bfd91d7d244ac1c7d337f0e37f35c29a1f35f49ccf649f02b0d9eb3ad65e29457bcbe75afcdc4f4cc3204aa510267fba959e588b1

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Bill Burcham
+
+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,59 @@
+# Hamstar
+
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hamstar'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hamstar
+
+## Usage
+
+`Hamstar.update_having` is a `module_function` that works just like [Hamster update_in()](https://github.com/hamstergem/hamster#transformations) but with two additional ways to select container elements:
+
+1. the associative selector denoted by an array containing a key and a value e.g. `[:name,'Chris']`
+2. the Kleen star operator denoted by '*'
+
+With plain old `update_in()` you can:
+
+```ruby
+require 'hamster'
+x = [{name:'Chris', hobbies:['clarinet']},{name:'Pat',hobbies:['bird watching','rugby']}]
+Hamster.from(x).update_in(1,:name){|name| 'Patsy'}
+=> Hamster::Vector[Hamster::Hash[:hobbies => Hamster::Vector["clarinet"], :name => "Chris"], Hamster::Hash[:hobbies => Hamster::Vector["bird watching", "rugby"], :name => "Patsy"]]
+```
+
+With Hamstar you can write code that is a little more flexibly:
+
+```ruby
+require 'hamstar'
+Hamstar.update_having( Hamster.from(x), 1,:name){|name| 'Patsy'}
+=> (same result as before)
+```
+
+And you can go further, and replace the vector offset `1` with the Kleene star `'*'` to operate on all elements of the vector:
+
+```ruby
+Hamstar.update_having( Hamster.from(x), '*',:name){|name| 'Patsy'}
+=> (same result as before)
+```
+
+See [`hamstar_spec.rb`](file://spec/hamstar_spec.rb) for more examples.
+
+
+## Contributing
+
+1. Fork it ( http://github.com/Bill/hamstar/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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/hamstar.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hamstar/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hamstar"
+  spec.version       = Hamstar::VERSION
+  spec.authors       = ["Bill Burcham"]
+  spec.email         = ["bill.burcham@gmail.com"]
+  spec.summary       = %q{Hamstar Transforms Immutable Ruby Collections Better}
+  spec.description   = %q{Hamstar.update_having() lets you transform deep amalgamations of Hamster (immutable) Hash and Vector with all the features of update_in() plus associative selection [key,val] and Kleene star '*'}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'hamster', '~> 2'
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/hamstar.rb

@@ -0,0 +1,51 @@
+require 'hamstar/version'
+require 'hamstar/initializers'
+require 'hamster'
+
+module Hamstar
+
+  KLEENE_STAR = '*'
+
+  module_function
+
+  def update_having(c, *key_path, &block)
+    if key_path.empty?
+      raise ArgumentError, "must have at least one key in path"
+    end
+    key = key_path[0]
+    case key
+    when KLEENE_STAR; kleene_star c, *key_path, &block
+    when Array, Hamster::Vector; association c, *key_path, &block
+    else
+      if key_path.size == 1
+        new_value = block.call c.fetch(key,nil)
+      else
+        value = c.fetch key, Hamster::EmptyHash
+        new_value = update_having value, *key_path[1..-1], &block
+      end
+      c.put key, new_value
+    end
+  end
+
+  def kleene_star(c, *key_path, &block)
+    kp_rest = Hamster.from(key_path)[1..-1] # drop kleene star
+    c.keys.each do |key|
+      kp = kp_rest.unshift key # put key where kleene star was
+      c = update_having c, *kp, &block
+    end
+    c
+  end
+
+  def association(c, *key_path, &block)
+    key,value = key_path[0]
+    kp_rest = Hamster.from(key_path)[1..-1] # drop assoc
+    c.each_pair do |k,v|
+      if v[key] == value
+        kp = kp_rest.unshift k # put key where assoc was
+        c = update_having c, *kp, &block
+      end
+    end
+    c
+  end
+
+end

data/lib/hamstar/initializers.rb

@@ -0,0 +1 @@
+require 'hamstar/initializers/hamster'

data/lib/hamstar/initializers/hamster.rb

@@ -0,0 +1,18 @@
+require 'hamster'
+
+module Hamster
+  class Vector
+    # Vectors act a lot like associations. Why not give 'em a keys method?
+    def keys
+      (0..(size-1))
+    end
+    def values
+      self
+    end
+    def each_pair
+      each_with_index do |v,i|
+        yield i,v
+      end
+    end
+  end
+end

data/lib/hamstar/version.rb

@@ -0,0 +1,3 @@
+module Hamstar
+  VERSION = "0.0.2"
+end

data/spec/hamstar_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+require 'hamstar'
+require 'hamster'
+
+RSpec.describe Hamstar do
+  examples_update_in_regression = [
+    [ {a:1},        [:b],      ->(v){2},   {a:1,b: 2},    'adds values for keys not already in Hash'],
+    [ [1],          [1],       ->(v){2},   [1,2],         'adds values for offsets not already in Vector'],
+    [ {a:1,b:[1,2]},[:b,1],    ->(v){v+1}, {a:1,b:[1,3]}, 'traverses Hash of Vector'],
+    [ [1,{b:2}],    [1,:b],    ->(v){v+1}, [1,{b:3}],     'traverses Vector of Hash'],
+  ]
+  examples_kleene_star = [
+    [ {a:1,b:2},    ['*'],     ->(v){v+1}, {a:2,b:3},     'top level Hash'],
+    [ [1,2],        ['*'],     ->(v){v+1}, [2,3],         'top level Vector'],
+    [ {a:[1],b:[2]},['*', 0],  ->(v){v+1}, {a:[2],b:[3]}, 'Vector underneath Hash'],
+    [ [{a:1},{a:2}],['*', :a], ->(v){v+1}, [{a:2},{a:3}], 'Hash underneath Vector']
+  ]
+
+  examples_associative = [
+    [ [{name:'Chris'},{name:'Pat'}], [ [:name, 'Pat'], :name ], ->(name){name<<'sy'}, [{name:'Chris'},{name:'Patsy'}], 'modify matching Hash']
+  ]
+
+  def self.write_examples(examples)
+    examples.each do |e|
+      it e[4] do
+        x = Hamster.from( e[0] )
+        y = Hamstar.update_having(x, *e[1], &e[2])
+        expect(Hamster.to_ruby y).to eq(e[3])
+      end
+    end
+  end
+
+  describe 'Inherited Hamster update_in functionality' do
+    write_examples examples_update_in_regression
+  end
+  describe 'New kleene star' do
+    write_examples examples_kleene_star
+  end
+  describe 'New association matching' do
+    write_examples examples_associative
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end
+
+require 'byebug'

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: hamstar
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Bill Burcham
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hamster
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: 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: rspec
+  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: Hamstar.update_having() lets you transform deep amalgamations of Hamster
+  (immutable) Hash and Vector with all the features of update_in() plus associative
+  selection [key,val] and Kleene star '*'
+email:
+- bill.burcham@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- hamstar.gemspec
+- lib/hamstar.rb
+- lib/hamstar/initializers.rb
+- lib/hamstar/initializers/hamster.rb
+- lib/hamstar/version.rb
+- spec/hamstar_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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: Hamstar Transforms Immutable Ruby Collections Better
+test_files:
+- spec/hamstar_spec.rb
+- spec/spec_helper.rb