mother 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a67400fbd3434ab48672cbb60695a344d0ba8087
+  data.tar.gz: c5564367ecac57cc878175de55b3c5e6b66c5178
+SHA512:
+  metadata.gz: ae5380c102c646f17fe497b00773c4a2900dc22a29f03bf44fccf76e63d6ede42060d01623ad705459f091cabc39e28ba5b240a2d7450c9fced2857ab791caf9
+  data.tar.gz: 7362f01bcb616d9b4f9ea2a58d384936a248ffb06cc3922b450680d39afdc743fda52f7abc5d5725766055161b43f77f0c39c608c03d6b336c203a679f689ba1

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.5.1
+before_install: gem install bundler -v 1.16.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,36 @@
+# Contributor Covenant Code of Conduct
+
+Please, let's be kind and considerate to each other.  Don't harrass or
+abuse anybody, regardless of age, body size, disability, ethnicity,
+gender identity and expression, level of experience, nationality,
+personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Some examples of unacceptable behavior by participants would include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in mother.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Joel Helbling
+
+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,188 @@
+# Mother
+
+In the culinary world, "mother" is a natural complex of bacteria, proteins, enzymes and
+fiber, which controls the fermentation of vinegar.  It has this property, that the mother
+derived in a new batch of vinegar can subsequently be used to start the fermentation of
+yet another batch.
+
+This gem proposes a similar arrangement, wherein a hash-like map or object comprises the
+un-fermented source, while Mother (the ruby gem) provides a "fermented" abstraction which
+1) provides convenient access to the hash's properties, and
+2) generates a new Mother for any accessed property which is, itself, another hash, so
+that hashes of hashes, once mothered, will yield children who are also mothers.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mother'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mother
+
+See?  Not so bad.
+
+## Usage
+
+Mother is easy to use.  If you have a hash like so:
+
+```ruby
+source = {
+  favorite_beverage: 'Chamomile Tea'
+}
+```
+
+Then create a Mother like so:
+
+```ruby
+mom = Mother.create source
+```
+
+And then you can call your mom (and you should!):
+
+```ruby
+mom.favorite_beverage #=> 'Chamomile Tea'
+```
+
+### Mother from another resource
+
+Mothers can create from hashes, but also from two popular hash-like file types, namely
+YAML and JSON.  These things will work (assuming the files actually exist):
+
+```ruby
+mom = Mother.create 'math/theorems.yml'
+mom = Mother.create './space_program.yaml'
+mom = Mother.create '/opt/var/kids/birthdays.json'
+```
+
+### My what big hashes you have!
+
+As mentioned earlier, Mothers can be grandmothers.  Let's expand our earlier hash:
+
+```ruby
+source = {
+  daughter: {
+    favorite_beverage: 'Gen Macha Tea'
+  }
+}
+```
+
+Then create a (grand)Mother just like we did before:
+
+```ruby
+mom = Mother.create source
+```
+
+And then we find that the daughter is also a Mother:
+
+```ruby
+mom.daughter.class #=> Mother
+```
+
+And indeed can be called in the same way:
+
+```ruby
+mom.daughter.favorite_beverage #=> 'Gen Macha Tea'
+```
+
+### There was an old woman who lived in a shoe...
+
+Mothers can also have whole broods of children (in Ruby these are called arrays),
+any of which could be mothers:
+
+```ruby
+source = {
+  brood: [
+    12,
+    'orange',
+    {
+      favorite_band: 'BTS'
+    }
+  ]
+}
+```
+
+We create the mother as usual:
+
+```ruby
+mom = Mother.create source
+```
+
+And then we find that we can access the array of children:
+
+```ruby
+mom.brood.first              #=> 12
+mom.brood[1]                 #=> 'orange'
+mom.brood.last.class         #=> Mother
+mom.brood.last.favorite_band #=> 'BTS'
+```
+
+### What About Demeter
+
+At this point, I'd like to give a cheery halo to Demeter, the Greek mother goddess of
+harvest, grain, and Persephone.  You may be familiar with the programming principle to
+which she has lent her name, namely the Law of Demeter, also known as the Principle of
+Least Knowledge.  According to this sage law, don't do this:
+
+```ruby
+thing_1.thing_2.thing_that_thing_2_can_do(plenty, of: arguments)
+```
+
+All those dots mean that our code, rather than just contenting itself with knowning how
+to use thing_1, must also be inculcated with the proper use of thing_2.  Bleh!
+
+Law of Demeter violations are Bad ™, and you'll die if you use 'em.  But in this
+case, let's relax our customary parsimony and play around with them a bit!
+
+I propose some guidelines:
+
+ - to keep things easy to reason about, consider not mutating your motherized hashes.  Just
+   treat them like facts which don't change.
+ - avoid accessing them very deeply in any given context.  Instead of calling the daughter
+   from the mother, and daisy-chaining calls to the daughter's attributes, instead hand
+   the daughter to another object, which can then access the daughter's attributes.
+ - don't worry so much.
+
+The use case for which I dreamed this gem up was that I wanted to collect all my magical
+values for a 2D game into a single YAML config file, and then be able to easily distribute
+the subsections to various objects within the game, and to provide easy, method-like
+access to all the properties (like they get to do with objects in JavaScript).
+
+## 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/joelhelbling/mother.
+This project is intended to be a safe, welcoming space for collaboration, and contributors are
+expected to adhere to the [Contributor Covenant](https://www.contributor-covenant.org) code of
+conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in Mother’s codebases, issue trackers, chat rooms and mailing lists shoulds
+expect to follow the [code of conduct](https://github.com/joelhelbling/mother/blob/master/CODE_OF_CONDUCT.md).
+
+## Dedication
+
+_I'd like to dedicate this gem to my Mom, who taught me to think analytically, who was my first
+and best math teacher, and who encourages me to do my best, even nowadays.  I love you, Mom._

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mother"
+
+# 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/lib/mother.rb

@@ -0,0 +1,58 @@
+require 'mother/version'
+require 'mother/collection'
+require 'yaml'
+require 'json'
+
+class Mother
+  attr_reader :data
+
+  def initialize(argument)
+    self.class.argument_failure! unless argument.is_a?(Hash)
+
+    @data = argument
+  end
+
+  def [](key)
+    self.class.create ___fetch(key)
+  end
+
+  def keys
+    @data.keys
+  end
+
+  def method_missing(method, *args, &block)
+    self[method]
+  end
+
+  private
+
+  def ___fetch(key)
+    @data[key.to_sym] or @data[key.to_s]
+  end
+
+  class << self
+    def create(thing)
+      case thing
+      when Array
+        Collection.new self, thing
+      when Hash
+        new thing
+      when String
+        case
+        when thing.match(/\.ya?ml$/)
+          self.create YAML.load(File.read(thing))
+        when thing.match(/\.json$/)
+          self.create JSON.parse(File.read(thing))
+        else
+          thing
+        end
+      else
+        thing
+      end
+    end
+
+    def argument_failure!
+      raise ArgumentError.new('Must be a hash, or YAML/JSON filename')
+    end
+  end
+end

data/lib/mother/collection.rb

@@ -0,0 +1,30 @@
+class Mother
+  class Collection
+    attr_reader :mother, :data
+
+    include Enumerable
+
+    def initialize(mother, argument)
+      mother.argument_failure! unless argument.is_a?(Array)
+
+      @mother = mother
+      @data = argument
+    end
+
+    def first
+      mother.create data.first
+    end
+
+    def last
+      mother.create data.last
+    end
+
+    def [](index)
+      mother.create data[index]
+    end
+
+    def each(&block)
+      data.map{ |i| mother.create i }.each(&block)
+    end
+  end
+end

data/lib/mother/version.rb

@@ -0,0 +1,3 @@
+class Mother
+  VERSION = "0.1.0"
+end

data/mother.gemspec

@@ -0,0 +1,32 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "mother/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "mother"
+  spec.version       = Mother::VERSION
+  spec.authors       = ["Joel Helbling"]
+  spec.email         = ["joel@joelhelbling.com"]
+
+  spec.summary       = %q{Method-ized access to a hash's children, and their children.}
+  spec.description   = %q{Ever wish you had effortless, JS-like access to a deeply nested yaml?}
+  spec.homepage      = "https://mother.joelhelbling.com"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 12.3"
+  spec.add_development_dependency "rspec", "~> 3.8"
+  spec.add_development_dependency "rspec-given", "~> 3.8"
+  spec.add_development_dependency "fakefs", "0.18.0"
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: mother
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joel Helbling
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-09-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !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: rspec-given
+  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: fakefs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+- !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'
+description: Ever wish you had effortless, JS-like access to a deeply nested yaml?
+email:
+- joel@joelhelbling.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/mother.rb
+- lib/mother/collection.rb
+- lib/mother/version.rb
+- mother.gemspec
+homepage: https://mother.joelhelbling.com
+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.6.14.1
+signing_key: 
+specification_version: 4
+summary: Method-ized access to a hash's children, and their children.
+test_files: []