hashtring 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6f83b210c5b457222fcd868fb13f462c182a3438
+  data.tar.gz: a12f61eff097d023fb34b5ce07380b138f67d0c1
+SHA512:
+  metadata.gz: 0635dd3747860003d4351ad9d1139ceb3e17235196267ef4737add71161c28917ef5fb249936bc9b953ab89acaf6c0b3ef306c317f9403c61ccf8eb8f7dccce9
+  data.tar.gz: 4edcc2faa73cfebbfeab668188a7fedd199f993672d70880ba7b52742d2f5ca9c6c3d565f52e9c0f087cf489790692a22fbbf1aa3380c94982bbc0718784800f

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+*.gem

data/.ruby-gemset

@@ -0,0 +1 @@
+hashtring

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Kyle Macey
+
+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,107 @@
+# Hashtring
+
+A Hashstring is an object that I wanted to experiment with. I was annoyed that i18n translations don't have a nice way of nesting under logical trees.
+
+For example, given:
+
+```yaml
+# en.yml
+
+reports:
+  marketing: Marketing Reports
+  sales: Sales Reports
+```
+
+Trying to call `I18n.t(:reports)` returns the hash of marketing and sales with their values. The solution would be to have two keys: an actual name and a namespace:
+
+```yaml
+# en.yml
+
+reports: Reports
+report_types:
+  marketing: Marketing Reports
+  sales: Sales Reports
+```
+
+I wanted to experiment with a pattern that wouldn't require sacrifice. Enter the Hashtring:
+
+```ruby
+reports = "Reports" ** {
+  marketing: "Marketing Reports",
+  sales: "Sales Reports"
+}
+
+puts reports # "Reports"
+puts reports.marketing # "Marketing Reports"
+```
+
+Sure, it may not be entirely practical, and it probably doesn't solve any *real* problems, but it was something I wanted to play around with.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hashtring'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hashtring
+
+## Usage
+
+To create a Hashtring, simply call the `#**` method on a string and give it a hash.
+
+```ruby
+"label" ** {
+  key1: "value1",
+  key2: "value2"
+}
+```
+
+One-liner:
+
+```ruby
+"label" ** key: "value"
+```
+
+You can even nest Hashtrings:
+
+```ruby
+orders = "Orders" ** {
+  line_items: "Line Items",
+  additional_charges: "Summary" ** {
+    tax: "NYS Tax",
+    shipping: "UPS Shipping"
+  }
+}
+```
+
+Call up values just like you would with a normal hash, but root nodes can be output as strings.
+
+```ruby
+puts orders # orders
+puts orders[:line_items] # "Line Items"
+puts orders[:additional_charges] # "Summary"
+puts orders[:additional_charges][:tax] # "NYS Tax"
+```
+
+For fun, I leveraged method_missing to give an i18n-like syntax
+
+```ruby
+puts orders.line_items # "Line Items"
+puts orders.additional_charges.tax # "NYS Tax"
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/KyleMacey/Hashtring/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,2 @@
+require "bundler/gem_tasks"
+

data/hashtring.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hashtring/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hashtring"
+  spec.version       = Hashtring::VERSION
+  spec.authors       = ["Kyle Macey"]
+  spec.email         = ["shout@kylemacey.com"]
+  spec.summary       = %q{An interesting class}
+  spec.homepage      = "https://github.com/KyleMacey/Hashtring"
+  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_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", '~> 3.2', '>= 3.2.0'
+end

data/lib/core_ext/string.rb

@@ -0,0 +1,5 @@
+String.class_eval do
+  def **(hash)
+    Hashtring::Constructor.new(self, hash)
+  end
+end

data/lib/hashtring.rb

@@ -0,0 +1,39 @@
+require "hashtring/version"
+require "core_ext/string"
+
+module Hashtring
+  class Constructor
+    attr_accessor :name, :hash
+
+    def initialize(name, hash={})
+      @name = name.to_s
+      @hash = hash
+    end
+
+    def [](*args)
+      hash.send(:[], *args)
+    end
+
+    def inspect
+      to_s
+    end
+
+    def method_missing(method_sym, *args, &block)
+      if stringify_keys(hash).has_key? method_sym.to_s
+        stringify_keys(hash).send(:[], method_sym.to_s)
+      else
+        super
+      end
+    end
+
+    def to_s
+      name.to_s
+    end
+
+    private
+
+    def stringify_keys(hash)
+      Hash[hash.map { |k, v| [k.to_s, v] }]
+    end
+  end
+end

data/lib/hashtring/version.rb

@@ -0,0 +1,3 @@
+module Hashtring
+  VERSION = "0.0.1"
+end

data/spec/lib/core_ext/string_spec.rb

@@ -0,0 +1,15 @@
+require "spec_helper"
+
+describe String do
+  describe "#**" do
+    subject do
+      "Reports" ** {
+        marketing: "Marketing Reports"
+      }
+    end
+
+    it "returns a Hashtring" do
+      expect(subject).to be_a(Hashtring::Constructor)
+    end
+  end
+end

data/spec/lib/hashtring/constructor_spec.rb

@@ -0,0 +1,49 @@
+require "spec_helper"
+
+describe Hashtring::Constructor do
+  subject do
+    Hashtring::Constructor.new(
+      "Reports", {
+        marketing: "Marketing Reports"
+      }
+    )
+  end
+
+  describe "#[]" do
+    it 'returns a value from the hash' do
+      expect(subject[:marketing]).to eq("Marketing Reports")
+    end
+
+    context "when the key does not exist" do
+      it "returns nil" do
+        expect(subject[:wrong]).to be_nil
+      end
+    end
+  end
+
+  describe "#inspect" do
+    it "returns the name" do
+      expect(subject.inspect).to eq("Reports")
+    end
+  end
+
+  describe "#method_missing" do
+    context "when the hash key exists" do
+      it "returns a value from the hash" do
+        expect(subject.marketing).to eq("Marketing Reports")
+      end
+    end
+
+    context "when the hash key does not exist" do
+      it "raises a no method error" do
+        expect{ subject.wrong }.to raise_error(NoMethodError)
+      end
+    end
+  end
+
+  describe "#to_s" do
+    it "returns the name" do
+      expect(subject.to_s).to eq("Reports")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'hashtring'

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: hashtring
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kyle Macey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+description: 
+email:
+- shout@kylemacey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- hashtring.gemspec
+- lib/core_ext/string.rb
+- lib/hashtring.rb
+- lib/hashtring/version.rb
+- spec/lib/core_ext/string_spec.rb
+- spec/lib/hashtring/constructor_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/KyleMacey/Hashtring
+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.4.5
+signing_key: 
+specification_version: 4
+summary: An interesting class
+test_files:
+- spec/lib/core_ext/string_spec.rb
+- spec/lib/hashtring/constructor_spec.rb
+- spec/spec_helper.rb