easy_settings 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 71cdfe95b74d1b5acc54abcd249e0647b0ef5ece
-  data.tar.gz: bf157033f6d5334369ceda9020de32c1ead1792e
+  metadata.gz: 66b0810ec966c00736a4eaef690c20165175bb39
+  data.tar.gz: 82bf4ff3af0cdfa919828e74726c877779eb3918
 SHA512:
-  metadata.gz: d436786a757ad9558285fe1aa2ef372203424d5488c25fb9f92f7a3fdd6d217800629fe34fc27c7f9b053df742fbead1b254c72542d55ee50c1e3a51df8ec6c1
-  data.tar.gz: b929886728c39e6ed070150e3c629a88c983850886156e632c15bd7b44c0e6285fc097193d037ca205ccc988eb18daccfc1e27d5437e9f48c33ed88bf2e29fe7
+  metadata.gz: 6048687c08e06e24432aeb5875d4f6ebd47b4b11c04ac4134850ded49d88a859fa39ff487f3d1d5dbb133dec1681d74c5f75e1aaca3e1d6bbaad25c30f73b800
+  data.tar.gz: cd08d5c305f3906664f084c94daaa7f78339ec5f963d5b42e79c6177162117d8b7cf120a6a1e472ee8a9ac1141f1689b8cea532283aa98afe2efc8f6b6e11f45

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2015 TODO: Write your name
+Copyright (c) 2015 nownabe
 
 MIT License
 

data/README.md

@@ -1,4 +1,9 @@
-# EasySettings [![Gem Version](https://badge.fury.io/rb/easy_settings.svg)](http://badge.fury.io/rb/easy_settings) [![Code Climate](https://codeclimate.com/github/nownabe/easy_settings/badges/gpa.svg)](https://codeclimate.com/github/nownabe/easy_settings) [![Test Coverage](https://codeclimate.com/github/nownabe/easy_settings/badges/coverage.svg)](https://codeclimate.com/github/nownabe/easy_settings) [![Build Status](https://travis-ci.org/nownabe/easy_settings.svg)](https://travis-ci.org/nownabe/easy_settings)
+# EasySettings
+[![Gem Version](https://badge.fury.io/rb/easy_settings.svg)](http://badge.fury.io/rb/easy_settings)
+[![Code Climate](https://codeclimate.com/github/nownabe/easy_settings/badges/gpa.svg)](https://codeclimate.com/github/nownabe/easy_settings)
+[![Test Coverage](https://codeclimate.com/github/nownabe/easy_settings/badges/coverage.svg)](https://codeclimate.com/github/nownabe/easy_settings)
+[![Build Status](https://travis-ci.org/nownabe/easy_settings.svg)](https://travis-ci.org/nownabe/easy_settings)
+
 EasySettings is a simple manager of setting constants.
 
 ## Installation
@@ -21,49 +26,62 @@ Or install it yourself as:
 EasySettings can load YAML file and understand ERB format.
 
 ### Basic usage
-Most simple usage is to put your settings file `settings.yml` to your application's root directory.
+Most simple usage is to put your settings file `settings.yml` to your application's directory.
 
 `settings.yml` or `config/settings.yml`:
 
 ```yaml
-app_name: EasySettingsSample
-users:
-  nownabe:
-    gender: male
-    like: ["Angra", "Helloween", "SEX MACHINEGUNS", "μ's"]
-timestamp: <%= Time.now.to_s %>
+log_level: info
+other_service:
+  endpoint: https://myapp/api/v1
+  apikey: API_KEY_XXX
+  secret: SECRET_KEY_XXX
+demo_users:
+  <% 5.times do |i| %>
+  - <%= "user%02d" % [i] %>
+  <% end %>
 ```
 
-And your application can use EasySettings:
+And you can use EasySettings constant in your application:
 
 ```ruby
 require "easy_settings"
 
-EasySettings.app_name    #=> "EasySettingsSample"
-EasySettings["app_name"] #=> "EasySettingsSample"
-EasySettings[:app_name]  #=> "EasySettingsSample"
+EasySettings.log_level #=> "info"
+```
 
-EasySettings.users
-#=> {"nownabe"=>{"gender"=>"male", "like"=>["Angra", "Helloween", "SEX MACHINEGUNS", "μ's"]}}
-EasySettings.users[:nownabe][:gender]
-#=> "male"
-EasySettings.users.nownabe.like
-#=> ["Angra", "Helloween", "SEX MACHINEGUNS", "μ's"]
+EasySettings hash can be used with method style, string keys and symbol keys:
 
-EasySettings.timestamp
-#=> 2015-03-07 00:11:28 +0900
+```ruby
+EasySettings.log_level    #=> "info"
+EasySettings["log_level"] #=> "info"
+EasySettings[:log_level]  #=> "info"
 ```
 
-You can set value to any key.
+EasySettings can treat nested hash:
+
+```ruby
+EasySettings.other_service
+#=> {"endpoint"=>"https://myapp/api/v1", "apikey"=>"API_KEY_XXX", "secret"=>"SECRET_KEY_XXX"}
+
+EasySettings.other_service.endpoint    #=> "https://myapp/api/v1"
+EasySettings.other_service["endpoint"] #=> "https://myapp/api/v1"
+EasySettings.other_service[:endpoint]  #=> "https://myapp/api/v1"
+```
+
+EasySettings process ERB format:
+
+```ruby
+EasySettings.demo_users
+#=> ["user00", "user01", "user02", "user03", "user04"]
+```
+
+You can set values.
 
 ```ruby
 EasySettings.app_name = "MyApp" #=> "MyApp"
 EasySettings["app_name"]        #=> "MyApp"
 EasySettings[:app_name]         #=> "MyApp"
-
-EasySettings["app_name"] = "MyApp2" #=> "MyApp2"
-EasySettings.app_name               #=> "MyApp2"
-EasySettings[:app_name]             #=> "MyApp2"
 ```
 
 If you want to use other settings file, you can use any other file with `EasySettings.source_file =`.
@@ -73,25 +91,22 @@ EasySettings.source_file = Rails.root.join("config/application.yml").to_s
 ```
 
 ### Namespace
-You can use namespace.
-
-Settings YAML file:
+You can use EasySettings with namespace:
 
 ```yaml
 defaults: &defaults
   app_name: NamespaceSample
-  endpoint: http://backend-dev/api/v1
 
-development:
+development: &development
   <<: *defaults
-  apikey: DEVFOOBAR123
-  secret: DEVBAZQUX789
+  endpoint: http://backend-dev/api/v1
+
+test:
+  <<: *development
 
 production:
   <<: *defaults
   endpoint: http://backend/api/v1
-  apikey: PRDFOOBAR123
-  secret: PRDBAZQUX789
 ```
 
 Using EasySettings with `namespace =`:
@@ -112,7 +127,7 @@ EasySettings.endpoint
 
 ### Default value
 You can set default value.
-Default value will be set with key when EasySettings doesn't have key.
+Default value will be set when EasySettings doesn't have value with the key yet.
 
 ```ruby
 EasySettings.has_key?(:foo)
@@ -151,17 +166,16 @@ EasySettings.has_key?(:app_name)
 And EasySettings can treat nested hash:
 
 ```ruby
-EasySettings.users({}).nownabe = {gender: :male}
-#=> {:gender=>:male}
+EasySettings.other_service({}).endpoint = "https://default/"
+#=> "https://default/"
 EasySettings.to_h
-#=> {"users"=>{"nownabe"=>{"gender"=>:male}}}
+#=> {"other_service"=>{"endpoint"=>"https://default/"}}
 ```
 
 Or more simple:
 
 ```ruby
-EasySettings.users!.nownabe = {gender: :male}
-#=> {:gender=>:male}
+EasySettings.other_service!.endpoint = "https://default/"
 ```
 
 ### Reset EasySettings
@@ -176,7 +190,7 @@ EasySettings.reload!
 ### Alias
 ```ruby
 Config = EasySettings
-Config.app_name = "AliasSample"
+Config.endpoint
 ```
 
 Or using class that inherit EasySettings:
@@ -189,9 +203,38 @@ end
 Config.endpoint
 ```
 
+## With Rails
+In your Gemfile:
+
+```ruby
+gem "easy_settings"
+```
+
+And write your settings in `config/settings.yml` with env:
+
+```ruby
+default: &default
+  app_name: MyApp
+  apikey: <%= ENV["APIKEY"] %>
+
+development:
+  <<: *default
+  endpoint: https://endpoint-for-development
+
+test:
+  <<: *default
+  endpoint: https://endpoint-for-test
+
+production:
+  <<: *default
+  endpoint: https://endpoint-for-production
+```
+
+Then you can access EasySettings anywhere.
+
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/easy_settings/fork )
+1. Fork it ( https://github.com/nownabe/easy_settings/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`)

data/Rakefile

@@ -1,6 +1,22 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
-RSpec::Core::RakeTask.new(:spec)
 task default: :spec
 
+desc "Run all test"
+task spec: ["spec:unit", "spec:rails"]
+
+namespace :spec do
+  RSpec::Core::RakeTask.new(:unit) do |t|
+    t.exclude_pattern = "./spec/easy_settings_test/**/*_spec.rb"
+  end
+
+  desc "Test for rails integration"
+  task :rails do
+    rails_root = File.expand_path("../spec/easy_settings_test", __FILE__)
+    Bundler.with_clean_env do
+      system("cd #{rails_root} && bundle install") || abort("Failed bundle install")
+      system("cd #{rails_root} && bundle exec rspec") || abort("Failed test in Rails app")
+    end
+  end
+end

data/lib/easy_settings.rb

@@ -2,12 +2,8 @@ require "hashie"
 require "yaml"
 require "erb"
 
-require "easy_settings_version"
-
 class EasySettings < Hashie::Mash
-  include EasySettingsVersion
-
-  class SourceFileNotExist < StandardError; end
+  SourceFileNotExist = Class.new(StandardError)
 
   DEFAULT_FILES = %w(settings.yml config/settings.yml)
 
@@ -58,12 +54,16 @@ class EasySettings < Hashie::Mash
 
     def _source_from_default_file
       DEFAULT_FILES.each do |f|
-        path = File.expand_path(f, Dir.pwd)
+        path = File.expand_path(f, _root_path)
         return _load_file(path) if FileTest.exist?(path)
       end
       {}
     end
 
+    def _root_path
+      Dir.pwd
+    end
+
     def method_missing(method_name, *args, &blk)
       instance.send(method_name, *args, &blk)
     end
@@ -78,16 +78,16 @@ class EasySettings < Hashie::Mash
     return self.[](method_name, &blk) if key?(method_name)
     name, suffix = method_suffix(method_name)
     case suffix
-    when '='
+    when "="
       assign_property(name, args.first)
-    when '?'
+    when "?"
       !!self[name]
-    when '!'
+    when "!"
       initializing_reader(name)
-    when '_'
+    when "_"
       underbang_reader(name)
     else
-      if !args[0].nil? or (args[1] and args[1][:nil])
+      if !args[0].nil? || (args[1] && args[1][:nil])
         assign_property(name, args.first)
       else
         self[method_name]
@@ -95,3 +95,7 @@ class EasySettings < Hashie::Mash
     end
   end
 end
+
+if Object.const_defined?(:Rails)
+  require "easy_settings/rails"
+end

data/lib/easy_settings/rails.rb

@@ -0,0 +1,8 @@
+class EasySettings
+  class Railtie < ::Rails::Railtie
+    initializer "easy_settings" do |app|
+      EasySettings.namespace   ||= Rails.env
+      EasySettings.source_file ||= Rails.root.join("config/settings.yml").to_s
+    end
+  end
+end

data/lib/easy_settings_version.rb

@@ -1,3 +1,3 @@
 module EasySettingsVersion
-  VERSION = "0.0.5"
+  VERSION = "0.1.0"
 end

data/spec/easy_settings_test/.env

@@ -0,0 +1 @@
+APIKEY="EASYSETTINGS"

data/spec/easy_settings_test/.gitignore

@@ -0,0 +1 @@
+/log/*.log

data/spec/easy_settings_test/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/spec/easy_settings_test/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gem 'rails', '4.2.4'
+gem 'jbuilder', '~> 2.0'
+gem "easy_settings", path: File.expand_path("../../../", __FILE__)
+gem "rspec-rails"
+gem "rspec-its"
+gem "dotenv-rails"

data/spec/easy_settings_test/Gemfile.lock

@@ -0,0 +1,139 @@
+PATH
+  remote: /Users/nownabe/src/github.com/nownabe/easy_settings
+  specs:
+    easy_settings (0.0.5)
+      hashie
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.2.4)
+      actionpack (= 4.2.4)
+      actionview (= 4.2.4)
+      activejob (= 4.2.4)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+    actionpack (4.2.4)
+      actionview (= 4.2.4)
+      activesupport (= 4.2.4)
+      rack (~> 1.6)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (4.2.4)
+      activesupport (= 4.2.4)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    activejob (4.2.4)
+      activesupport (= 4.2.4)
+      globalid (>= 0.3.0)
+    activemodel (4.2.4)
+      activesupport (= 4.2.4)
+      builder (~> 3.1)
+    activerecord (4.2.4)
+      activemodel (= 4.2.4)
+      activesupport (= 4.2.4)
+      arel (~> 6.0)
+    activesupport (4.2.4)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    arel (6.0.3)
+    builder (3.2.2)
+    diff-lcs (1.2.5)
+    dotenv (2.0.2)
+    dotenv-rails (2.0.2)
+      dotenv (= 2.0.2)
+      railties (~> 4.0)
+    erubis (2.7.0)
+    globalid (0.3.6)
+      activesupport (>= 4.1.0)
+    hashie (3.4.2)
+    i18n (0.7.0)
+    jbuilder (2.3.2)
+      activesupport (>= 3.0.0, < 5)
+      multi_json (~> 1.2)
+    json (1.8.3)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    mail (2.6.3)
+      mime-types (>= 1.16, < 3)
+    mime-types (2.6.2)
+    mini_portile (0.6.2)
+    minitest (5.8.1)
+    multi_json (1.11.2)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    rack (1.6.4)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (4.2.4)
+      actionmailer (= 4.2.4)
+      actionpack (= 4.2.4)
+      actionview (= 4.2.4)
+      activejob (= 4.2.4)
+      activemodel (= 4.2.4)
+      activerecord (= 4.2.4)
+      activesupport (= 4.2.4)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.2.4)
+      sprockets-rails
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.7)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6.0)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.2)
+      loofah (~> 2.0)
+    railties (4.2.4)
+      actionpack (= 4.2.4)
+      activesupport (= 4.2.4)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.4.2)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-its (1.2.0)
+      rspec-core (>= 3.0.0)
+      rspec-expectations (>= 3.0.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-rails (3.3.3)
+      actionpack (>= 3.0, < 4.3)
+      activesupport (>= 3.0, < 4.3)
+      railties (>= 3.0, < 4.3)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    sprockets (3.3.5)
+      rack (> 1, < 3)
+    sprockets-rails (2.3.3)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (>= 2.8, < 4.0)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  dotenv-rails
+  easy_settings!
+  jbuilder (~> 2.0)
+  rails (= 4.2.4)
+  rspec-its
+  rspec-rails