persey 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1105cc74f8880197636a93ea4c1990547c8cc85a
-  data.tar.gz: 9dbd7aded17e89ebf3b4c0e36f0ab5773eed5925
+  metadata.gz: 64a5c154b43d81e9f986339f73a9f85cc861b059
+  data.tar.gz: 0c5d8a0d96946015c87777d12efd69fa49aa9921
 SHA512:
-  metadata.gz: 32c3ee1921e3a4559b4ea28c41cd833bdc0f49d4ed6c0cc40f2b44d644764c1362d059fb1d710d18278e867eb53a281cd8bc65d09c24155b17669aca95d88d99
-  data.tar.gz: 9aaab88972ebc844865da7426f2407a66bdfd562bca82ae07e615bff8f044d276320dbfbad06244dcac29c6c3dc45252b872c6ad337a0a0aa1ea72416497d55b
+  metadata.gz: eb9d2a412b8f013c8982a6984b53175b97c034b9081dbef94ff7da76b31ec8724783f1ddde0078d4e97253d7d08e15d402775fba6ad8ee406f554869d211d27e
+  data.tar.gz: 636a151f73fd8710e75b19eafb2afcec3ce83096e0c7071649c3b4760c517c31d43e556e9c744efa9eeb645242845748e2cd188ff0ee8a6db929d63ec2b85d21

data/.travis.yml

@@ -1,6 +1,6 @@
 language: ruby
 rvm:
+  - 1.9.3
   - 2.0.0
   - 2.1.0
-  - jruby
 script: "bundle exec rake test"

data/README.md

@@ -7,37 +7,92 @@ Persey help you easily manage the configuration, depending on the environment.
 The main objective is to provide opportunities to reuse the
 configuration provided by the project, as the default configuration.
 
+## Problem
+
+For the occurrence of the gem was a few prerequisites.
+
+ * Work on opensource projects that support the relevance of problem configurations, changing the appearance of new versions and functionality. 
+ * Use in the project configuration, diversity in different files, and the inability to unite all in one configuration 
+ * Desire to use sensitive data as easily as those that can be safely stored in the repository.
+ * Sometimes configuration happens in a variety of formats: yaml, json, ini 
+
+I do not want to engage in writing parsers, I want to work fine :) 
+
+This solution allows to **accumulate** different configs in one, with the **possibility of reusability** of configuration options and **simple override**. It uses an **intuitive DSL**.
+
 ## Installing
 
 Add this to your `Gemfile`:
 
-    gem "persey"
+``` ruby
+gem "persey", '>= 0.0.6'
+```
+
+Generate default config file
+
+``` bash
+$ rails g persey:install
+```
 
 ## Examples
 
 ### Definition
 
 ``` ruby
-redis_config = File.join(Rails.root, 'config', redis.yml.example)
-project_config = File.join(Rails.root, 'config', project.yml.example)
-awesome_gem_config = File.join(Rails.root, 'config', awesome_gem_config.yml)
+# Rails.root are not initialized here
+app_path = File.expand_path('../../', __FILE__)
+
+# your redis config
+redis_config = File.join(app_path, 'config', 'redis.yml.example')
+
+# your project config
+# as example - it's default options from opensource
+# you don't want redeclare then with copy default file
+project_config = File.join(app_path, 'config', 'project.yml.example')
+
+# some different environment specifed configuration options in separate config
+project_env_config = File.join(app_path, 'config', "project.#{Rails.env}.yml")
+
+# config for awesome gem
+awesome_gem_config = File.join(app_path, 'config', 'awesome_gem_config.yml')
+
+# config with secret keys
+# you don't want store this config in repository and copy to secret folder on host machine
 my_secret_key_config = '/home/user/secret/keys.yml'
 
-Persey.init :development do # set current environment
-  sourse :yaml,   redis_config,   :redis   # set specific namespace for settings
-  project :yaml,  project_config
-  project :yaml,  awesome_gem_config
-  project :yaml,  my_secret_key_config
+# We support not only YAML
+# Also JSON
+my_node_js_config = '/rest/u/apps/node/config.json'
+# And TOML
+my_berkshelf_config = File.join(app_path, 'provisioning', '.berkshelf')
+# And INI
+my_ini_config = File.join(app_path, 'provisioning', 'php.ini') # lol
+
+# Persey.init ENV["environment"] do # set current environment
+Persey.init Rails.env do # set current environment
+  sourse :yaml, redis_config,         :redis              # set specific namespace for settings (mount config in :redis key)
+  source :yaml, project_config                            # if project config and project_env_config have some options keys
+  source :yaml, project_env_config                        # last declared keys overwite before declared
+  source :yaml, awesome_gem_config,   :awesome_gem        # it's good to mount unknown configs to special :namespace
+  source :yaml, my_secret_key_config, :secret             # no comments. It's secret!
+  source :json, my_node_js_config,    :node_js_namespace
+  source :toml, my_berkshelf_config,  :berkshelf_namespace
+  source :ini,  my_ini_config,        :ini_namespace
 
   env :production do
     site_name 'Example'
     web do
-      domain   'example.com'
-      protocol 'https'
-      port     80
+      # domain   'example.com'   # domain described in project_env_config
+                                 # you can use them, or overwirite here
+      protocol 'https'           # we overwrite prolocol option here
+                                 # by default was 'http', but we need some little security
+      port      12345            # more, more security!
+      # and now we use configs for our options, which are not declared in any config
       uri      -> { "#{protocol}://#{domain}:#{port}" }
     end
-    site_uri   -> { web.uri }
+    
+    site_uri   -> { web.uri }    # we can re-re-use different options
+    
     email do
       pop do
         address 'pop.example.com'
@@ -63,34 +118,84 @@ Persey.init :development do # set current environment
     end
   end
 end
+```
+If you generate Persey config with run `rails g persey:install` in your `config/application.rb` were added strings to run config initialization. If you do not run installer, you can specify of run config manually. For example:
+
+in your `config/application.rb`
+
+``` ruby
+#...
+# We require gem here
+require "persey"
+require File.expand_path('../config', __FILE__)
+
+module AppName
+  # If you don't want use configs with call Persey.config
+  # you can do something like it:
+  def self.config
+    Persey.config
+  end
+  
+  class Application < Rails::Application
+    # ...
+  end
+end
+
 ```
 
 ### Usage
 
-    config = Persey.config
+``` ruby
+config = Persey.config
+
+config.site_name      # => 'Example'
+config.web.uri        # => 'https://example.com:80'
+config.site_uri       # => 'https://example.com:80'
+config.email.pop.port # => 110
 
-    config.site_name      # => 'Example'
-    config.web.uri        # => 'https://example.com:80'
-    config.site_uri       # => 'https://example.com:80'
-    config.email.pop.port # => 110
+AppName.config.site_name # => 'Example'
+```
 
 ### Rails
 
-define your config in `lib/config.rb`
+define your config in `config/config.rb`
 
-    Persey.init Rails.env do
-      # settings
-    end
+``` ruby
+Persey.init Rails.env do
+  # settings
+end
+```
 
 reload
 
-    # config/environments/development.rb
-    ActionDispatch::Reloader.to_prepare do
-      load Rails.root.join('lib/config.rb')
-    end
+``` ruby
+# config/environments/development.rb
+ActionDispatch::Reloader.to_prepare do
+  load Rails.root.join('config/config.rb')
+end
+```
+
+## Supported config formats
+
+* YAML
+* JSON
+* TOML
+* INI
 
 ## Similar
 
 * https://github.com/kaize/configus (this gem based on configus)
 * https://github.com/markbates/configatron
 * https://github.com/railsjedi/rails_config
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+6. Push to the branch (`git push origin my-new-feature`)
+7. Create new Pull Request
+
+## Another help
+
+You can give me feedback with issue.

data/lib/generators/persey/install/install_generator.rb

@@ -0,0 +1,34 @@
+module Persey
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      def create_configuration
+        copy_file("config.rb", "config/config.rb")
+        inject_into_file 'config/application.rb', before: "module #{Rails.application.class.parent_name}" do
+          <<-'RUBY'
+require "persey"
+require File.expand_path('../config', __FILE__)
+
+          RUBY
+        end
+      end
+
+      def ignore_configuration
+        if File.exists?("config/config.rb")
+          append_to_file("config/config.rb") do
+            <<-EOF.strip_heredoc
+
+              # Define method in #{Rails.application.class.parent_name}
+              module #{Rails.application.class.parent_name}
+                def self.config
+                  Persey.config
+                end
+              end
+              EOF
+          end
+        end
+      end
+    end
+  end
+end

data/lib/generators/persey/install/templates/config.rb

@@ -0,0 +1,31 @@
+# Rails.root are not initialized here
+app_path = File.expand_path('../../', __FILE__)
+
+# config_path = File.join(app_path, 'config', 'awesome_config.yml.example')
+
+Persey.init Rails.env do # set current environment
+  # source :yaml, config_path, :mount_namespace
+  # source :json, config_path, :mount_namespace
+  # source :toml, config_path, :mount_namespace
+  # source :ini,  config_path, :mount_namespace
+
+  env :default do
+    # declare here some config option for all environments
+  end
+
+  env :production, parent: :default do
+    # redeclare here some specific keys for production environment
+  end
+
+  env :development, parent: :production do
+    # redeclare here some specific keys for development environment
+  end
+
+  env :staging, parent: :production do
+    # redeclare here some specific keys for staging environment
+  end
+
+  env :test, parent: :development do
+    # redeclare here some specific keys for test environment
+  end
+end

data/lib/persey.rb

@@ -2,7 +2,11 @@ require "persey/version"
 require "persey/builder"
 require "persey/inspector"
 require "persey/loader"
+require "persey/adapters/base"
 require "persey/adapters/yaml"
+require "persey/adapters/json"
+require "persey/adapters/toml"
+require "persey/adapters/ini"
 require "persey/configus_patch"
 
 module Persey

data/lib/persey/adapters/base.rb

@@ -0,0 +1,20 @@
+module Persey
+  module Adapters
+    class Base
+      class << self
+        def load(file, env)
+          raise NotImplementedError
+        end
+
+        def symbolize_keys(hash)
+          hash.inject({}){|res, (k, v)|
+            n_k = k.is_a?(String) ? k.to_sym : k
+            n_v = v.is_a?(Hash) ? symbolize_keys(v) : v
+            res[n_k] = n_v
+            res
+          }
+        end
+      end
+    end
+  end
+end

data/lib/persey/adapters/ini.rb

@@ -0,0 +1,18 @@
+require 'inifile'
+
+module Persey
+  module Adapters
+    class Ini < Persey::Adapters::Base
+      class << self
+        def load(file, env)
+          begin
+            raw_hash = IniFile.load(file).to_h
+            symbolize_keys(raw_hash)
+          rescue
+            puts "FATAL: Error while process config from file '#{file}'"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/persey/adapters/json.rb

@@ -1,18 +1,20 @@
+require 'yajl'
+
 module Persey
   module Adapters
-    class Json
-
+    class Json < Persey::Adapters::Base
       class << self
         def load(file, env)
           begin
-            raw_hash = YAML.load_file(file)
+            json = File.new(file, 'r')
+            parser = Yajl::Parser.new
+            raw_hash = parser.parse(json)
             symbolize_keys(raw_hash)
           rescue
-            binding.pry
+            puts "FATAL: Error while process config from file '#{file}'"
           end
         end
       end
-
     end
   end
 end

data/lib/persey/adapters/toml.rb

@@ -0,0 +1,18 @@
+require 'toml'
+
+module Persey
+  module Adapters
+    class Toml < Persey::Adapters::Base
+      class << self
+        def load(file, env)
+          begin
+            raw_hash = TOML.load_file(file)
+            symbolize_keys(raw_hash)
+          rescue
+            puts "FATAL: Error while process config from file '#{file}'"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/persey/adapters/yaml.rb

@@ -2,27 +2,16 @@ require 'yaml'
 
 module Persey
   module Adapters
-    class Yaml
+    class Yaml < Persey::Adapters::Base
       class << self
         def load(file, env)
           begin
             raw_hash = YAML.load_file(file)
             symbolize_keys(raw_hash)
           rescue
-            binding.pry
+            puts "FATAL: Error while process config from file '#{file}'"
           end
         end
-
-        private
-
-        def symbolize_keys(hash)
-          hash.inject({}){|res, (k, v)|
-            n_k = k.is_a?(String) ? k.to_sym : k
-            n_v = v.is_a?(Hash) ? symbolize_keys(v) : v
-            res[n_k] = n_v
-            res
-          }
-        end
       end
     end
   end

data/lib/persey/version.rb

@@ -1,3 +1,3 @@
 module Persey
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/persey.gemspec

@@ -20,4 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency "activesupport"
   spec.add_runtime_dependency 'configus', '>= 0.0.5'
+  spec.add_runtime_dependency 'yajl-ruby'
+  spec.add_runtime_dependency "toml", "~> 0.1.0"
+  spec.add_runtime_dependency "inifile"
 end

data/test/fixtures/ini_config.ini

@@ -0,0 +1,11 @@
+[section1]
+; some comment on section1
+var1 = foo
+var2 = doodle
+var3 = multiline values \
+are also possible
+
+[section2]
+# another comment
+var1 = baz
+var2 = shoodle

data/test/fixtures/json_config.json

@@ -0,0 +1,26 @@
+{
+  "header":{
+    "modified":"1 April 2001",
+    "dc:author": "John Doe"
+  },
+  "logger_root":{
+    "level":"NOTSET",
+    "handlers":"hand01"
+  },
+  "logger_parser":{
+    "level":"DEBUG",
+    "handlers":"hand01",
+    "propagate":"1",
+    "qualname":"compiler.parser"
+  },
+  "owner":{
+    "name":"John Doe",
+    "organization":"Acme Widgets Inc."
+  },
+  "database":{
+    "server":"192.0.2.62",
+    "_comment_server":"use IP address in case network name resolution is not working",
+    "port":"143",
+    "file":"payroll.dat"
+  }
+}

data/test/fixtures/toml_config.toml

@@ -0,0 +1,35 @@
+# This is a TOML document. Boom.
+
+title = "TOML Example"
+
+[owner]
+name = "Tom Preston-Werner"
+organization = "GitHub"
+bio = "GitHub Cofounder & CEO\nLikes tater tots and beer."
+dob = 1979-05-27T07:32:00Z # First class dates? Why not?
+
+[database]
+server = "192.168.1.1"
+ports = [ 8001, 8001, 8002 ]
+connection_max = 5000
+enabled = true
+
+[servers]
+
+  # You can indent as you please. Tabs or spaces. TOML don't care.
+  [servers.alpha]
+  ip = "10.0.0.1"
+  dc = "eqdc10"
+
+  [servers.beta]
+  ip = "10.0.0.2"
+  dc = "eqdc10"
+
+[clients]
+data = [ ["gamma", "delta"], [1, 2] ]
+
+# Line breaks are OK when inside arrays
+hosts = [
+  "alpha",
+  "omega"
+]

data/test/lib/persey_test.rb

@@ -4,10 +4,16 @@ class PerseyTest < TestCase
   def setup
     plain_config = File.join(fixtures_path, 'yaml_config.yml')
     env_config = File.join(fixtures_path, 'yaml_config_with_envs.yml')
+    plain_json_config = File.join(fixtures_path, 'json_config.json')
+    plain_toml_config = File.join(fixtures_path, 'toml_config.toml')
+    plain_ini_config = File.join(fixtures_path, 'ini_config.ini')
 
     Persey.init :production do
       source :yaml, plain_config
-      source :yaml, env_config, :namespace
+      source :yaml, env_config,         :namespace
+      source :json, plain_json_config,  :json_config
+      source :toml, plain_toml_config,  :toml_config
+      source :ini,  plain_ini_config,   :ini_config
 
       env :production do
         option do
@@ -27,5 +33,8 @@ class PerseyTest < TestCase
     assert { @config.option.first == "first value" }
     assert { @config.namespace.another_key == "another key value" }
     assert { @config.key == "key value" }
+    assert { @config.json_config.owner.name == "John Doe" }
+    assert { @config.toml_config.owner.name == "Tom Preston-Werner" }
+    assert { @config.ini_config.section1.var1 == "foo" }
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: persey
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Andrey Kumanyaev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-26 00:00:00.000000000 Z
+date: 2014-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -38,6 +38,48 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: 0.0.5
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: toml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: inifile
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Persey helps you easily load configs from different files and use them
   from one variable. Based on Configus.
 email:
@@ -52,8 +94,13 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- lib/generators/persey/install/install_generator.rb
+- lib/generators/persey/install/templates/config.rb
 - lib/persey.rb
+- lib/persey/adapters/base.rb
+- lib/persey/adapters/ini.rb
 - lib/persey/adapters/json.rb
+- lib/persey/adapters/toml.rb
 - lib/persey/adapters/yaml.rb
 - lib/persey/builder.rb
 - lib/persey/configus_patch.rb
@@ -61,6 +108,9 @@ files:
 - lib/persey/loader.rb
 - lib/persey/version.rb
 - persey.gemspec
+- test/fixtures/ini_config.ini
+- test/fixtures/json_config.json
+- test/fixtures/toml_config.toml
 - test/fixtures/yaml_config.yml
 - test/fixtures/yaml_config_with_envs.yml
 - test/lib/persey_test.rb
@@ -90,6 +140,9 @@ signing_key:
 specification_version: 4
 summary: Helps you easily manage environment specific settings
 test_files:
+- test/fixtures/ini_config.ini
+- test/fixtures/json_config.json
+- test/fixtures/toml_config.toml
 - test/fixtures/yaml_config.yml
 - test/fixtures/yaml_config_with_envs.yml
 - test/lib/persey_test.rb