chickpea 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 739146440bbc01fd856df4b4bd2b4464386b9a82883bb6a75c9571cf80fc65ed
+  data.tar.gz: 3c896a3f9cc9d950127607389e28d024ad1edb97e30b8211a412d6a1ec846c1d
+SHA512:
+  metadata.gz: 63b1d663180e3cc38786a6b1008999c952f5fe2f7432d1329c58ce4e2885ecdf7d92784af7f4f7087945f2b48d71ddd68a3c5d19ebd33aa21c377d70ae1a51e2
+  data.tar.gz: 2bbdb71c207995dcf41320f0b3f0361fa5c25c2998047cba29784133165fbc68320bc910ae9c1536bb8db920b1772212516976079bb5522f881d7124eefff6ce

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.2
+before_install: gem install bundler -v 2.0.1

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Stone Tickle
+
+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 @@
+# Chickpea
+
+A simple ruby stash.  It is basically a nested struct with a few extra
+features.
+
+## Features
+
++ Immutable structure - the structure you define can't be mutated.  Only the
+  value of nodes can.
++ Type checking - when you set a node, its type (class) is checked against the
+  old node and an exception is raised if there is a mismatch
++ Fast - there is no underlying hash or struct, so if you don't need to mutate
+  data often chickpea is pretty fast (about 2.5 x slower than Hash)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'chickpea'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install chickpea
+
+## Usage
+```ruby
+stash = Chickpea.new(
+  a: {
+    b: {
+      c: {
+        d: 1
+      }
+    },
+    bb: false
+  }
+)
+
+stash.a.b.c.d #=> 1
+stash.a.bb? #=> false
+stash.a.b.c.d = 4 #=> 4
+stash.a.b.c.d = false #=> TypeError
+stash.a.b.c = 1 #=> NoMethodError
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+task :bench do
+  sh "bundle exec ruby spec/benchmark.rb"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'chickpea'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/chickpea.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'chickpea/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'chickpea'
+  spec.version       = Chickpea::VERSION
+  spec.authors       = ['Stone Tickle']
+  spec.email         = ['lattis@mochiro.moe']
+
+  spec.summary       = 'A simple stash'
+  spec.license       = 'MIT'
+
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'benchmark-ips'
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rspec', '~> 3.8'
+  spec.add_development_dependency 'simplecov'
+end

data/lib/chickpea/stash.rb

@@ -0,0 +1,44 @@
+module Chickpea
+  class Stash
+    class<<self
+      def make_stash(hash)
+        klass = Class.new
+
+        hash.map do |key, val|
+          obj =
+            if val.is_a?(Hash)
+              make_stash(val)
+            else
+              val.tap do |v|
+                case v
+                when true, false
+                  klass.define_method(:"#{key}?") { obj }
+                  klass.define_method(:"#{key}=") do |nv|
+                    unless nv == true || nv == false
+                      raise(TypeError, "expected #{nv.inspect} to be a Boolean")
+                    end
+
+                    define_singleton_method(key) { nv }
+                  end
+                else
+                  klass.define_method(:"#{key}=") do |nv|
+                    unless nv.is_a?(obj.class)
+                      raise(TypeError, "expected #{nv.inspect} to be a #{v.class}")
+                    end
+
+                    define_singleton_method(key) { nv }
+                  end
+                end
+              end
+            end
+
+          klass.define_method(key) { obj }
+        end
+
+        klass.new
+      end
+
+      alias new make_stash
+    end
+  end
+end

data/lib/chickpea/version.rb

@@ -0,0 +1,3 @@
+module Chickpea
+  VERSION = '0.2.0'.freeze
+end

data/lib/chickpea.rb

@@ -0,0 +1,50 @@
+require 'chickpea/version'
+
+module Chickpea
+  class TypeError < ::TypeError
+    def initialize(got, expected)
+      super("expected #{got.inspect} to be a #{expected}")
+    end
+  end
+
+  class<<self
+    def make_stash(hash)
+      klass = Class.new
+
+      hash.map do |key, val|
+        obj =
+          if val.is_a?(Hash)
+            make_stash(val)
+          else
+            val.tap do |v|
+              case v
+              when true, false
+                klass.define_method(:"#{key}?") { obj }
+                klass.define_method(:"#{key}=") do |nv|
+                  unless nv == true || nv == false
+                    raise(TypeError.new(nv, :Boolean))
+                  end
+
+                  define_singleton_method(key) { nv }
+                end
+              else
+                klass.define_method(:"#{key}=") do |nv|
+                  unless nv.is_a?(obj.class)
+                    raise(TypeError.new(nv, obj.class.name))
+                  end
+
+                  define_singleton_method(key) { nv }
+                end
+              end
+            end
+          end
+
+        klass.define_method(key) { obj }
+      end
+
+      klass.new
+    end
+
+    alias new make_stash
+  end
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: chickpea
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Stone Tickle
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-04-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: 
+email:
+- lattis@mochiro.moe
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- chickpea.gemspec
+- lib/chickpea.rb
+- lib/chickpea/stash.rb
+- lib/chickpea/version.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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A simple stash
+test_files: []