hash-to-obj 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ee934fea5eddeefa8540e7691d2b39b28e1e948c
+  data.tar.gz: b5b7c45e8ffd2d74b4cd84f4051a2184a85c4d2f
+SHA512:
+  metadata.gz: b79470f4236a73cab06c10bb5494fdcd20e62ee98c9802854b4325497203e4193dbca745ff1c66857b8da66cf0eed2fecd62b25975d15780e5de3c1fdd6e7321
+  data.tar.gz: e19f7befcd4897b53aa8cbb170928222317570532bdbe6c5180e651dc718443709cb82b95cb88c71367898ca8eae5bfc110d8e4932641d78c9132735b2835e02

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/README.md

@@ -0,0 +1,28 @@
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hash-to-obj'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hash-to-obj
+
+## Usage
+
+Once installed you can simply call `objectify` on a hash to objectify it!
+
+```ruby
+my_hash = { a: 1, b: 2, c: 3 }
+objectify my_hash
+my_hash.a # 1
+my_hash.b = "b" # { a: 1, b: "b", c: 3 }
+```
+
+If you add new elements to the hash it will not currently create helper methods.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :test_dsl do
+  ruby "spec/hash-to-obj_helper.rb"
+end
+
+task :default => [:spec, :test_dsl]

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/hash-to-obj.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hash-to-obj/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'hash-to-obj'
+  spec.version       = HashToObj::VERSION
+  spec.authors       = ['Sam Maxwell']
+  spec.email         = ['raindropenter@gmail.com']
+
+  spec.summary       = 'Simple Ruby gem to objectify hashes'
+  spec.description   = "Call 'objectify my_hash' to add accessor methods to "\
+                       'my_hash based on the keys currently in the has.'
+  spec.homepage      = 'https://github.com/ReinAkane/hash-to-obj'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'pry', '>= 0'
+end

data/lib/hash-to-obj.rb

@@ -0,0 +1,115 @@
+require 'hash-to-obj/version'
+
+##
+# We extend this to objectify our hashes. It will generate some methods on the
+# hash to access the various keys.
+#
+# Define a constant HashToObj::SQUELCH_GLOBAL_WARNINGS to squelch warnings about
+# objectify already being defined.
+module HashToObj
+  ##
+  # Anything that you want to objectify needs to respond to these methods like a
+  # Hash would. If it doesn't at least respond_to? these methods, an error will
+  # be thrown when objectifying.
+  DUCK_TYPE_API = [:[], :[]=].freeze
+
+  ##
+  # Throws an error if hash doesn't have all messages defined in DUCK_TYPE_API.
+  # Generates the accessors for all keys on the passed hash. Unless
+  # override_warnings is true-y, this will throw errors if we're gonna screw
+  # anything up. If you pass something that responds to :puts in
+  # override_warnings then warnings will just be puts'd to that, and things will
+  # continue.
+  def self.objectify(hash, override_warnings = false)
+    # Make sure it looks SOMEWHAT familiar.
+    DUCK_TYPE_API.each do |method_sym|
+      unless hash.respond_to?(method_sym) then
+        raise(ArgumentError,
+              "Cannot objectify something that doesn't look like a hash.")
+      end
+    end
+
+    # Now lets actually add those methods.
+    hash.each_key do |key|
+      generate_accessors(hash, key, override_warnings)
+    end
+
+    hash
+  end
+
+  ##
+  # Generates the accessors for the passed key on the passed hash. Unless
+  # override_warnings is true-y, this will throw errors if we're gonna screw
+  # anything up. If you pass something that responds to :puts in
+  # override_warnings then warnings will just be puts'd to that, and things will
+  # continue.
+  def self.generate_accessors(hash, key, override_warnings = false)
+    handle_warnings(hash, key, override_warnings)
+
+    valid_key = valid_key?(key)
+    hash.define_singleton_method(valid_key) { self[key] }
+    hash.define_singleton_method("#{valid_key}=") do |value|
+      self[key] = value
+    end
+  end
+
+  ##
+  # This will output any warnings we want to output.
+  def self.handle_warnings(hash, key, override_warnings = false)
+    if !override_warnings && should_warn?(hash, key) then
+      if override_warnings.respond_to?(:puts) then
+        override_warnings.puts(should_warn?(hash, key))
+      else
+        raise ArgumentError, should_warn?(hash, key)
+      end
+    end
+  end
+
+  ##
+  # Returns a valid method name for the passed key if there is one, otherwise
+  # returns false.
+  def self.valid_key?(key)
+    regex_match = key.to_s.match(/\A[a-z_][a-z0-9_]*\Z/)
+    return false if regex_match.nil?
+    return key.to_s
+  end
+
+  ##
+  # If there should be a warning, returns the warning message. Otherwise returns
+  # false.
+  def self.should_warn?(hash, key)
+    valid_key = valid_key?(key)
+
+    # Make sure its a valid key...
+    return "#{key} is not a valid key." unless valid_key
+    # And make sure they don't have this method...
+    if hash.respond_to?(valid_key) then
+      return "#{hash} already has a #{valid_key} method defined."
+    end
+    if hash.respond_to?("#{valid_key}=") then
+      return "#{hash} already has a #{valid_key}= method defined."
+    end
+
+    false
+  end
+end
+
+# This is an ugly ugly way of checking if the objectify method is defined
+# somewhere already. For whatever reason :respond_to? is simply not returning
+# the correct result.
+if begin
+    method(:objectify)
+    true
+  rescue NameError
+    false
+  end then
+
+  unless HashToObj.const_defined?(:SQUELCH_GLOBAL_WARNINGS) then
+    puts 'Global already has an objectify method. '\
+         'Call HashToObj.objectify instead.'
+  end
+else
+  def objectify(hash, override_warnings = false)
+    HashToObj.objectify(hash, override_warnings)
+  end
+end

data/lib/hash-to-obj/version.rb

@@ -0,0 +1,3 @@
+module HashToObj
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: hash-to-obj
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sam Maxwell
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.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: Call 'objectify my_hash' to add accessor methods to my_hash based on
+  the keys currently in the has.
+email:
+- raindropenter@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/setup
+- hash-to-obj.gemspec
+- lib/hash-to-obj.rb
+- lib/hash-to-obj/version.rb
+homepage: https://github.com/ReinAkane/hash-to-obj
+licenses: []
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Simple Ruby gem to objectify hashes
+test_files: []