dot_hash 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 39b7417393fe9bedfd168b25cbef8acab0610fc0
-  data.tar.gz: fff127d3af33e47e58ef51e8493ad1c1521b7f57
+  metadata.gz: 7018ca020ba869170194582fc6d71ec4cddbc187
+  data.tar.gz: e864953ad473baac57823386d63892028a24db4e
 SHA512:
-  metadata.gz: 99110126469ff816221d67b4bd34a426c9544206584c528ee6947c778574cb66b3516cf65772c222a1f0df19852b7e319438631754f701a29a975ea450a2a37b
-  data.tar.gz: 46f93563bfeea0c1966a813c344581a0c7afc4e40692d811c77c71623b39e02a0e3116c5e244dd3af05ffba16b5bd1302072e9dd67da1f4d5ae9614eb88bba3a
+  metadata.gz: 288f017493329d2e3fba220f8eeaefba7720f36e1aa9087055a0a939c712d4660fde84c9b2ab9e712c842d4e5dbd330a5a3a1a7dae21e834697989601f29a328
+  data.tar.gz: 1a1f2c30f1ab511ffd5b08408c1f6c61812cb26f21a897d888ee396c03dfc1edc0223d960fde56f63dc93b4b8889ccc2ebb5cca9a3f55361ea7c9ed1939481bd

data/.rake_tasks

@@ -0,0 +1,7 @@
+build
+clean
+clobber
+install
+install:local
+release[remote]
+test

data/README.md

@@ -20,18 +20,28 @@ Or install it yourself as:
 
 ## Usage
 
+You can convert and hash to DotHash's properties.
+
 ```ruby
 some_hash = {size: {height: 100, width: 500}, "color" => "red"}
-properties = some_hash.to_properties
+properties = DotHash.load(some_hash)
 
 properties.size.height # returns 100, it is the same as some_hash[:size][:height]
 properties.color       # returns "red", it works with Strings and Symbol keys
 properties[:color]     # returns "red", can be used like a hash with string keys
 properties["color"]    # returns "red", can be used like a hash with symbol keys
+```
+
+You can use DotHash::Settings to manage all configs of your app it can load yml, json with or without ERB code embeded.
 
+```ruby
 # App Settings
 class Settings < DotHash::Settings
-  load 'path/to/some/settings.yaml', 'path/to/settings-directory/', {something: 'Some Value'}
+  load(
+    'path/to/some/settings.json',
+    'path/to/settings-directory/',
+    {something: 'Some Value'}
+  )
 end
 
 # Use the settings as a Singleton
@@ -40,10 +50,23 @@ Settings.other.stuff.from_yml_settings
 
 # Create a settings instance from some YML
 swagger = Settings.new Rails.root.join('config', 'my-swagger.yml')
-
 swagger.info.title # returns the title from swagger doc
 ```
 
+DotHash supports Rails and is very easy to manage fancy settings with it.
+
+```ruby
+class Settings < DotHash::Settings
+   load(
+      Rails.root.join('config', 'settings.yml'), # loads config/settings.yml
+      Rails.root.join('package.json'), # loads package.json
+      *Dir(Rails.root.join('config', 'settings', '*.yml')), # loads all config/settings/*.yml but dont go to nested directories
+      Rails.root.join('config', 'settings', Rails.env), # loads all files on config/settings/<env>/
+      Rails.root.join('config', 'settings.local.yml') # loads config/settings.local.yml
+   )
+end
+```
+
 Check the tests for more details.
 
 ## Contributing

data/lib/dot_hash.rb

@@ -4,7 +4,14 @@ require 'yaml'
 require 'json'
 require 'erb'
 require 'dot_hash/properties'
-require 'dot_hash/hash_to_properties'
 require 'dot_hash/loader'
 require 'dot_hash/settings'
 require 'dot_hash/version'
+
+module DotHash
+  class << self
+    def load(*args)
+      Loader.new(*args).properties
+    end
+  end
+end

data/lib/dot_hash/loader.rb

@@ -6,12 +6,16 @@ module DotHash
       @hashes = hashes
     end
 
-    def load
+    def hash
       hashes.inject({}) do |hash, arg|
         merge_hashes hash, get_hash_from(arg)
       end
     end
 
+    def properties
+      Properties.new hash
+    end
+
     def merge_hashes(h1, h2)
       return h1 unless h2
       return h2 unless h1
@@ -29,7 +33,7 @@ module DotHash
     def get_hash_from arg
       if arg.is_a? Hash
         arg
-      elsif File.file? arg
+      elsif File.file? arg.to_s
         get_hash_from_file arg
       elsif File.directory? arg
         get_hash_from_directory arg
@@ -37,8 +41,14 @@ module DotHash
     end
 
     def get_hash_from_file(file)
-      return {} unless file =~ /\.(yaml|yml)(\.erb)?$/
-      YAML.load load_erb(file)
+      case file
+      when /\.ya?ml(\.erb)?$/
+        YAML.load load_erb(file)
+      when /\.json(\.erb)?$/
+        JSON.parse load_erb(file)
+      else
+        {}
+      end
     end
 
     def load_erb(file)

data/lib/dot_hash/settings.rb

@@ -1,12 +1,14 @@
 module DotHash
   class Settings < Properties
     def initialize(*args)
-      super Loader.new(*args).load
+      super Loader.new(*args).hash
     end
 
-    class << self
-      attr_reader :instance
+    def load(*args)
+      @hash = Loader.new(hash, *args).hash
+    end
 
+    class << self
       def method_missing(*args, &block)
         instance.public_send(*args, &block)
       end
@@ -16,11 +18,13 @@ module DotHash
       end
 
       def load(*args)
-        @instance = new(*args)
+        instance.load(*args)
       end
 
-      def namespace(namespace)
-        @instance = @instance[namespace]
+      private
+
+      def instance
+        @instance ||= new({})
       end
     end
   end

data/lib/dot_hash/version.rb

@@ -1,3 +1,3 @@
 module DotHash
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

data/test/dot_hash/custom_settings_test.rb

@@ -1,24 +1,19 @@
 require_relative "../test_helper"
 
 class CustomSettings < DotHash::Settings
-  load attributes: {power: 10, skills: ["fireball", "frost"]}
+  load(
+    fixtures_path, # load from many sources and merges everything
+    attributes: {power: 10, skills: ["fireball", "frost"]}
+  )
 end
 
 describe CustomSettings do
-  it "loads the given settings" do
-    assert_equal CustomSettings.attributes.power, 10
-    assert_equal CustomSettings.attributes.skills, ["fireball", "frost"]
-  end
-end
-
-class CustomSettings2 < DotHash::Settings
-  load attributes: {power: 10, name: "Eden", skills: ["fireball", "frost"]}
-  namespace :attributes
-end
-
-describe CustomSettings2 do
-  it "loads the settings within the namespace" do
-    assert_equal CustomSettings2.power, 10
-    assert_equal CustomSettings2.skills, ["fireball", "frost"]
+  it "loads the all given settings" do
+    assert_equal CustomSettings.to_hash, {
+      "default"=>{"attr"=>{"speed"=>10, "power"=>11}},
+      "rogue"=>{"attr"=>{"speed"=>25, "power"=>11}},
+      "hero"=>{"name"=>"Eden", "power"=>100, "location"=> TESTS_PATH},
+      :attributes=>{:power=>10, :skills=>["fireball", "frost"]}
+    }
   end
 end

data/test/dot_hash/loader_test.rb

@@ -2,59 +2,58 @@ require_relative "../test_helper"
 
 module DotHash
   describe Loader do
-
-    describe "#load" do
+    describe "#hash" do
       it "merges the given hashes" do
         loader = Loader.new(
           {a: 1, b: {c: 2}},
           {b: {x: {z: 10}}}
         )
-        assert_equal loader.load,({a: 1, b: {c: 2, x: {z: 10}}})
+        assert_equal loader.hash, {a: 1, b: {c: 2, x: {z: 10}}}
       end
 
       it "loads from a file" do
-        loader = Loader.new fixtures_path("configs1.yaml")
+        loader = Loader.new fixtures_path("configs1.yml")
 
-        assert_equal loader.load,({
+        assert_equal loader.hash, {
           "default" => {"attr" => {"speed"=>10, "power"=>11}},
           "rogue" => {"attr" => {"speed"=>20, "power"=>11}}
-        })
+        }
       end
 
       it "loads from two files" do
         loader = Loader.new(
-          fixtures_path("configs1.yaml"),
-          fixtures_path("configs2.yaml")
+          fixtures_path("configs1.yml"),
+          fixtures_path("configs2.json")
         )
 
-        assert_equal loader.load,({
+        assert_equal loader.hash,({
           "default"=>{"attr"=>{"speed"=>10, "power"=>11}},
           "rogue"=>{"attr"=>{"speed"=>25, "power"=>11}}
         })
       end
 
-      it "does not load files without the yaml extension" do
+      it "does not hash files without the yaml extension" do
         loader = Loader.new fixtures_path("config.yaml.example")
 
-        assert_equal loader.load,({})
+        assert_equal loader.hash, {}
       end
 
       it "loads from a directory" do
         loader = Loader.new fixtures_path
 
-        assert_equal loader.load,({
+        assert_equal loader.hash, {
           "default"=>{"attr"=>{"speed"=>10, "power"=>11}},
           "rogue"=>{"attr"=>{"speed"=>25, "power"=>11}},
           "hero"=>{"name"=>"Eden", "power"=>100, "location"=>TESTS_PATH}
-        })
+        }
       end
 
       it "loads ERB files" do
         loader = Loader.new fixtures_path("configs3.yaml.erb")
 
-        assert_equal loader.load,({
+        assert_equal loader.hash, {
           "hero"=>{"name"=>"Eden", "power"=>100, "location"=>TESTS_PATH}
-        })
+        }
       end
     end
   end

data/test/dot_hash/settings_test.rb

@@ -38,14 +38,28 @@ module DotHash
       end
     end
 
-    describe ".instance" do
-      before do
-        configs = {site: "skyo.com"}
-        Settings.load configs
-      end
-
-      it "returns a singleton instance of the settings" do
-        Settings.instance.must_be_instance_of Settings
+    describe "#load" do
+      it 'merges new hashes' do
+        # starts as a empty hash
+        settings = Settings.new
+        assert_equal settings.hash, {}
+
+        # loads a new hash
+        settings.load({"name" => 'bar'})
+        assert_equal settings.hash, {"name" => "bar"}
+
+        # replaces existent props
+        settings.load({"name" => 'foo'})
+        assert_equal settings.hash, {"name" => "foo"}
+
+        # loads more stuff from a file
+        settings.load(fixtures_path)
+        assert_equal settings.hash, {
+          "name" => "foo",
+          "default" => {"attr" => {"speed"=>10, "power"=>11}},
+          "rogue"=>{"attr"=>{"speed"=>25, "power"=>11}},
+          "hero"=>{"name"=>"Eden", "power"=>100, "location"=> TESTS_PATH}
+        }
       end
     end
 
@@ -93,15 +107,15 @@ module DotHash
 
       describe "loading from files" do
         it "loads from a file" do
-          Settings.load fixtures_path("configs1.yaml")
+          Settings.load fixtures_path("configs1.yml")
           assert_equal Settings.rogue.attr.speed, 20
           assert_equal Settings.rogue.attr.power, 11
         end
 
         it "loads from two files" do
           Settings.load(
-            fixtures_path("configs1.yaml"),
-            fixtures_path("configs2.yaml")
+            fixtures_path("configs1.yml"),
+            fixtures_path("configs2.json")
           )
 
           assert_equal Settings.rogue.attr.speed, 25

data/test/{dot_hash/hash_to_properties_test.rb → dot_hash_test.rb}

@@ -1,13 +1,14 @@
-require_relative "../test_helper"
+require_relative "./test_helper"
 
-describe Hash do
+describe DotHash do
   attr_reader :properties
 
-  describe "#to_propertires" do
+  describe ".load" do
     before do
-      @properties = {
-        "price" => 10, info: {name: "eagle"}
-      }.to_properties
+      @properties = DotHash.load({
+        "price" => 10,
+        info: {name: "eagle"}
+      })
     end
 
     it "returns a DotHash object" do

data/test/fixtures/configs2.json

@@ -0,0 +1,7 @@
+{
+  "rogue": {
+    "attr": {
+      "speed": 25
+    }
+  }
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dot_hash
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Marcelo Eden
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-30 00:00:00.000000000 Z
+date: 2017-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -46,6 +46,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rake_tasks"
 - ".travis.yml"
 - Gemfile
 - LICENSE
@@ -53,19 +54,18 @@ files:
 - Rakefile
 - dot_hash.gemspec
 - lib/dot_hash.rb
-- lib/dot_hash/hash_to_properties.rb
 - lib/dot_hash/loader.rb
 - lib/dot_hash/properties.rb
 - lib/dot_hash/settings.rb
 - lib/dot_hash/version.rb
 - test/dot_hash/custom_settings_test.rb
-- test/dot_hash/hash_to_properties_test.rb
 - test/dot_hash/loader_test.rb
 - test/dot_hash/properties_test.rb
 - test/dot_hash/settings_test.rb
+- test/dot_hash_test.rb
 - test/fixtures/config.yaml.example
-- test/fixtures/configs1.yaml
-- test/fixtures/configs2.yaml
+- test/fixtures/configs1.yml
+- test/fixtures/configs2.json
 - test/fixtures/configs3.yaml.erb
 - test/test_helper.rb
 homepage: https://github.com/3den/dot_hash
@@ -93,12 +93,12 @@ specification_version: 4
 summary: Converts hash.to_properties so you can access values using properties.some_key
 test_files:
 - test/dot_hash/custom_settings_test.rb
-- test/dot_hash/hash_to_properties_test.rb
 - test/dot_hash/loader_test.rb
 - test/dot_hash/properties_test.rb
 - test/dot_hash/settings_test.rb
+- test/dot_hash_test.rb
 - test/fixtures/config.yaml.example
-- test/fixtures/configs1.yaml
-- test/fixtures/configs2.yaml
+- test/fixtures/configs1.yml
+- test/fixtures/configs2.json
 - test/fixtures/configs3.yaml.erb
 - test/test_helper.rb

data/lib/dot_hash/hash_to_properties.rb

@@ -1,9 +0,0 @@
-module DotHash
-  module HashToProperties
-    def to_properties
-      Properties.new self
-    end
-  end
-end
-
-Hash.send :include, DotHash::HashToProperties

data/test/fixtures/configs2.yaml

@@ -1,3 +0,0 @@
-rogue:
-  attr:
-    speed: 25