inde_struct 1.0.0

data/History.txt

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2015-03-24
+
+* 1 major enhancement
+
+  * Birthday!
+

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Step1Profit
+
+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/Manifest.txt

@@ -0,0 +1,16 @@
+History.txt
+LICENSE
+Manifest.txt
+README.md
+Rakefile
+bin/inde_struct
+inde_struct.gemspec
+lib/inde_struct.rb
+lib/inde_struct/parser.rb
+lib/inde_struct/parser/hash_any_case.rb
+lib/inde_struct/parser/open_struct_any_case.rb
+lib/inde_struct/reader.rb
+lib/inde_struct/version.rb
+test/files/config.yml
+test/files/empty.yml
+test/test_inde_struct.rb

data/README.md

@@ -0,0 +1,123 @@
+#IndeStruct
+
+https://github.com/step1profit/inde_struct
+
+##DESCRIPTION
+
+Ruby global Constant configuration variables with indifferent access. In other words, the same configuration value with non-case-sensitive accessor.
+
+##FEATURES
+
+* Case-insensitive access to variables - access your way... instead of changing the original config file
+* Accepts Hash or YAML-string
+* Read YAML from filepath or File class
+
+##SYNOPSIS
+
+###Ruby env
+
+Hash
+
+```ruby
+hash = {whatever: 'awesome'}
+# create global constant
+CONFIG = IndeStruct.ible(hash)
+```
+
+YAML-string
+
+```ruby
+yaml_string = "---\nwhatever: awesome\n"
+CONFIG = IndeStruct.ible(yaml_string)
+```
+
+Filepath
+
+```ruby
+# some_dir/config.yml # => "---\nwhatever: awesome\n"
+filepath = 'some_dir/config.yml'
+CONFIG = IndeStruct.ible(filepath)
+```
+
+File
+
+```ruby
+# some_dir/config.yml # => "---\nwhatever: awesome\n"
+file = File.open('test/files/config.yml')
+CONFIG = IndeStruct.ible(file)
+```
+
+###Rails env
+
+```ruby
+# in your_rails_app/config/application.rb
+
+require 'inde_struct' # if not required via Gemfile
+# assuming existing your_rails_app/config/application.yml # => "---\nwhatever: awesome\n"
+hash = YAML.load(File.read(File.expand_path('../application.yml', __FILE__)))
+# using environment specific configs (optional)
+hash.merge!(hash[Rails.env]||{})
+# create global constant
+CONFIG = IndeStruct.ible(hash)
+
+#module YourRailsApp
+#  class Application < Rails::Application
+# [...]
+```
+
+### Result
+
+Result is the same for both Ruby env and Rails env
+
+```ruby
+# wherever you want:
+CONFIG.whaTeVer # => 'awesome'
+CONFIG.wHAteveR # => 'awesome'
+CONFIG.WHaTevER # => 'awesome'
+CONFIG.whatEVEr # => 'awesome'
+CONFIG.WHATevEr # => 'awesome'
+CONFIG.WHateVeR # => 'awesome'
+```
+
+##REQUIREMENTS
+
+* Ruby 1.9 or higher
+
+##INSTALL
+
+Command Line
+
+```
+$ gem install inde_struct
+```
+
+Gemfile
+
+```ruby
+gem 'inde_struct'
+```
+
+##LICENSE
+
+(The MIT License)
+
+Copyright (c) 2015 Step1Profit
+
+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/Rakefile

@@ -0,0 +1,21 @@
+# -*- ruby -*-
+
+require "rubygems"
+require "hoe"
+
+# Hoe.plugin :compiler
+# Hoe.plugin :gem_prelude_sucks
+Hoe.plugin :gemspec
+# Hoe.plugin :git
+# Hoe.plugin :inline
+# Hoe.plugin :racc
+# Hoe.plugin :rcov
+# Hoe.plugin :rdoc
+Hoe.plugin :yard
+
+Hoe.spec "inde_struct" do
+  developer("Step1Profit", "sales@step1profit.com")
+  license "MIT"
+end
+
+# vim: syntax=ruby

data/bin/inde_struct

@@ -0,0 +1,2 @@
+#!/usr/bin/env ruby
+

data/lib/inde_struct.rb

@@ -0,0 +1,14 @@
+require 'inde_struct/version'
+require 'inde_struct/reader'
+require 'inde_struct/parser'
+
+module IndeStruct
+  extend self
+
+  def ible(arg)
+    obj = arg.is_a?(Hash) ? arg : IndeStruct::Reader.read(arg)
+    IndeStruct::Parser.parse(obj)
+  end
+
+  alias_method :new, :ible
+end

data/lib/inde_struct/parser.rb

@@ -0,0 +1,24 @@
+require 'inde_struct/parser/open_struct_any_case'
+
+module IndeStruct
+  module Parser
+    extend self
+
+    def parse(obj)
+      return case obj
+      when Hash
+        obj = obj.clone
+        obj.each do |k,v|
+          obj[k] = self.parse(v)
+        end
+        IndeStruct::Parser::OpenStructAnyCase.new(obj)
+      when Array
+        obj = obj.clone
+        obj.map! {|i| self.parse(i)}
+      else
+        obj
+      end
+    end
+
+  end
+end

data/lib/inde_struct/parser/hash_any_case.rb

@@ -0,0 +1,15 @@
+module IndeStruct
+  module Parser
+    class HashAnyCase < Hash
+
+      def [](key)
+        key.respond_to?(:upcase) ? super(key.upcase) : super(key)
+      end
+
+      def []=(key, value)
+        key.respond_to?(:upcase) ? super(key.upcase, value) : super(key, value)
+      end
+
+    end
+  end
+end

data/lib/inde_struct/parser/open_struct_any_case.rb

@@ -0,0 +1,21 @@
+require 'ostruct'
+require 'inde_struct/parser/hash_any_case'
+
+module IndeStruct
+  module Parser
+    class OpenStructAnyCase < OpenStruct
+
+      def initialize(hash=nil)
+        @table = IndeStruct::Parser::HashAnyCase.new
+        if hash
+          hash.each_pair do |k, v|
+            k = k.to_sym
+            @table[k] = v
+            new_ostruct_member(k)
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/inde_struct/reader.rb

@@ -0,0 +1,26 @@
+require 'yaml'
+
+module IndeStruct
+  module Reader
+    extend self
+
+    class EmptyFileError < StandardError; end
+    class EmptyInputError < StandardError; end
+    class InvalidInputError < StandardError; end
+    class InputError < StandardError; end
+
+    #
+    # parses YAML file or string into Ruby Hash
+    #
+    def read(input)
+      raise EmptyInputError if input.is_a?(String) && input.strip.empty?
+      raise InvalidInputError unless input.is_a?(String) or input.is_a?(File)
+      # read to string if File
+      input = IO.read(input) if input.is_a?(File) or File.exist?(input)
+      raise EmptyFileError if input.strip.empty?
+      x = YAML.load(input)
+      raise InputError, 'YAML input did not parse to Hash' unless x.is_a?(Hash)
+      return x
+    end
+  end
+end

data/lib/inde_struct/version.rb

@@ -0,0 +1,3 @@
+module IndeStruct
+  VERSION = "1.0.0"
+end

data/test/files/config.yml

@@ -0,0 +1,2 @@
+---
+awesome: dude

data/test/test_inde_struct.rb

@@ -0,0 +1,50 @@
+gem "minitest"
+require "minitest/autorun"
+require "inde_struct"
+require "securerandom"
+
+# randomize case of String
+def rand_case(x)
+  x.gsub(/./){|y| [y,y.swapcase][rand(2)]}
+end
+
+class TestIndeStruct < Minitest::Test
+  def setup
+    @files = File.join(File.expand_path(File.dirname(__FILE__)), "files")
+  end
+
+  def text_ible_hash
+    act = IndeStruct.ible({awesome: 'dude'})
+    assert_kind_of(IndeStruct::Parser::OpenStructAnyCase, act)
+  end
+
+  def test_ible_string
+    act = IndeStruct.ible("awesome: dude")
+    assert_kind_of(IndeStruct::Parser::OpenStructAnyCase, act)
+  end
+
+  def test_ible_filepath
+    filepath = File.join @files, 'config.yml'
+    assert File.exist? filepath
+    act = IndeStruct.ible(filepath)
+    assert_kind_of(IndeStruct::Parser::OpenStructAnyCase, act)
+  end
+
+  def test_ible_file
+    filepath = File.join(@files, 'config.yml')
+    assert File.exist? filepath
+    file = File.open(filepath)
+    assert_kind_of(File, file)
+    act = IndeStruct.ible(file)
+    assert_kind_of(IndeStruct::Parser::OpenStructAnyCase, act)
+    file.close
+  end
+
+  def test_ible_accessor_case_sensitivity
+    key = SecureRandom.urlsafe_base64(rand(1..16))
+    exp = 'awesome'
+    config = IndeStruct.ible({key => exp})
+    act = config.send(rand_case(key))
+    assert_equal(exp, act)
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: inde_struct
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Step1Profit
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hoe-yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.13'
+description: Ruby global Constant configuration variables with indifferent access.
+  In other words, the same configuration value with non-case-sensitive accessor.
+email:
+- sales@step1profit.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- History.txt
+- LICENSE
+- Manifest.txt
+- README.md
+- Rakefile
+- bin/inde_struct
+- lib/inde_struct.rb
+- lib/inde_struct/parser.rb
+- lib/inde_struct/parser/hash_any_case.rb
+- lib/inde_struct/parser/open_struct_any_case.rb
+- lib/inde_struct/reader.rb
+- lib/inde_struct/version.rb
+- test/files/config.yml
+- test/files/empty.yml
+- test/test_inde_struct.rb
+homepage: https://github.com/step1profit/inde_struct
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Ruby global Constant configuration variables with indifferent access. In
+  other words, the same configuration value with non-case-sensitive accessor.
+test_files: []
+has_rdoc: