rails_simple_config 0.0.3 → 0.0.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4c89164a55cdd5a6bf2f9f713ae2243212cd4638e1fbd2e4810540e500ea1dd2
+  data.tar.gz: 6b417ae172e9a2d0a1ad71924bc5fbdc736ae33e5d155bc6c4b8837c340d85ea
+SHA512:
+  metadata.gz: 5907458a1a536e9cef7fbca1f379773c0165e5eda32c0f01fc45cf8161b81ba735a344511bf646f0884568bfe55e50f63e6fe8173a1407c859fd67e2ca4f37d4
+  data.tar.gz: 7b56bd45d8f31088a1280dd7311e10d4048e41daf3de5c14530207e0a5926409bcd5ccf3536be5c0ea8b02b02e3a95f519742fc406ad5b671db2f3bccb5816a7

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rails_simple_config (0.0.1)
+    rails_simple_config (0.0.7)
 
 GEM
   remote: http://rubygems.org/
@@ -12,3 +12,6 @@ PLATFORMS
 
 DEPENDENCIES
   rails_simple_config!
+
+BUNDLED WITH
+   2.2.31

data/README.md

@@ -1,5 +1,7 @@
 # Rails Simple Config
 
+[![Gem Version](https://badge.fury.io/rb/rails_simple_config.png)](http://badge.fury.io/rb/rails_simple_config)
+
 A simple YAML based configuration for Ruby on Rails 3+, which supports shared settings, ERB and more.
 
 Inspired in part by the database configuration in Rails, [app_config](https://github.com/die-antwort/app_config) and [rails_config](https://github.com/railsjedi/rails_config).
@@ -10,15 +12,21 @@ Add RailsSimpleConfig to your Gemfile:
 
     gem 'rails_simple_config'
 
-Run the generator to create the default configuration file:
+Run the generator to create the default configuration files:
 
     rails generate rails_simple_config:install
     
-The generator will create 3 files in your Rails root directory; namely `secrets.yml`, `secrets.example.yml` and `config.yml`. 
+The generator will create 3 files in your Rails `config` directory, namely:
+
+* `secrets.yml`
+* `secrets.example.yml`
+* `config.yml`
 
-The `secrets.yml` should _not_ be committed to source control, and it should be used to keep settings which are 
-considered a secret; such as your Amazon credentials. These settings will be loaded first. The `secrets.example.yml` filename
-can be added to source control and kept as an _example_ of the settings contained in the `secrets.yml` file.
+The `secrets.yml` should _not_ be committed to source control. It should be used to keep settings which are 
+considered a secret; such as your Amazon credentials. It is loaded first.
+
+The `secrets.example.yml` file can be added to source control and should serve as an _example_ of the settings 
+contained in the `secrets.yml` file.
 
 The `config.yml` file should contain all other configuration settings.
 
@@ -26,21 +34,25 @@ The `config.yml` file should contain all other configuration settings.
 
 ### Define configuration settings
 
-Define your settings in the generated `secrets.yml` and `config.yml` file, found in your Rails root directory. 
+Define your settings in the generated `secrets.yml` and `config.yml` files, found in your Rails `config` directory. 
 
-The file contains sections for the development, test and production Rails environments, and a shared section.
+Both files contain a shared section and sections with overrides for the respective development, test and production Rails environments.
 It can also contain ERB code so that more advanced configuration scenarios can be supported.
 
     # example configuration
     
     shared: &shared
+
       title: My Website Title
       description: Meta description of the site
       keywords: Meta keywords for search engines
       
       no_reply_email: noreply@example.com
+
+      dynamic_setting: <%= 30 * 60 %>
       
     development:
+
       # inherit shared settings
       <<: *shared
       
@@ -52,6 +64,7 @@ It can also contain ERB code so that more advanced configuration scenarios can b
       mail_prefix: DEV -
     
     production:
+
       # inherit shared settings
       <<: *shared
       
@@ -63,7 +76,7 @@ It can also contain ERB code so that more advanced configuration scenarios can b
 
 ### Access configuration settings
 
-To access configuration settings in your Rails application, use the `SimpleConfig` global module.
+To access configuration settings in your Rails application, use the `SimpleConfig` global or the `AppConfig` alias for it.
 
 For example, in your application layout:
 
@@ -83,8 +96,8 @@ For example, in your application layout:
       </body>
     </html>          
 
-In addition, unlike other Rails configuration solutions, `SimpleConfig` is available to the development, test and production configurations, initializers and routes during startup.
-It can be used as a replacement for environment variables; thus making your setup much cleaner.
+In addition, unlike other Rails configuration solutions, `SimpleConfig` is available to the Rails development, test and production environment configuration files, 
+initializers and routes during startup. It can be used as a replacement for environment variables; thus making your setup and code much cleaner.
 
 For example, the `SimpleConfig.no_reply_email` will be accessible to the [devise](https://github.com/plataformatec/devise) initializer when configuring `mailer_sender`:
 
@@ -101,10 +114,10 @@ For example, the `SimpleConfig.no_reply_email` will be accessible to the [devise
 
 ### Notes
 
-`SimpleConfig` inherits from [ActiveSupport::OrderedOptions](http://api.rubyonrails.org/classes/ActiveSupport/OrderedOptions.html), so accessing undefined settings will always return `nil`.
+`SimpleConfig` makes use of the [ActiveSupport::OrderedOptions](http://api.rubyonrails.org/classes/ActiveSupport/OrderedOptions.html) class, so accessing undefined settings will always return `nil`.
 
-In development, the configuration is reloaded upon each request, however, any configuration used within the `application.rb` filename
-or any initializers will _not_ be automatically reloaded, without having to restart your web server.
+In development, the configuration is reloaded upon each request, however, any configuration used within the `application.rb` file and initializers 
+will _not_ be automatically reloaded, without having to restart your web server.
 
 ## Project Info
 

data/lib/generators/rails_simple_config/install/USAGE

@@ -1,5 +1,5 @@
 Description:
-  Creates the default configuration file (config.yml) in the project root directory.
+  Creates the default configuration file (config.yml) in the project config directory.
   
 Example:
   `rails generate rails_simple_config:install`

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

@@ -1,12 +1,11 @@
 module RailsSimpleConfig
   class InstallGenerator < Rails::Generators::Base
     source_root File.expand_path('../templates', __FILE__)
-    
+
     def copy_files
-      template "config.yml", "./config.yml"
-      template "secrets.yml", "./secrets.yml"
-      template "secrets.yml", "./secrets.example.yml"
+      template "config.yml", File.join("config", "config.yml")
+      template "secrets.yml", File.join("config", "secrets.yml") unless File.exist?(File.join("config", "secrets.yml"))
     end
-  
+
   end
 end

data/lib/generators/rails_simple_config/install/templates/config.yml

@@ -12,9 +12,12 @@ shared: &shared
 
   # application settings
   title: Example
-  description: 
-  keywords: 
-  version:
+  description:
+  version: 0.0.1
+
+  # vendor information
+  vendor: "Your Company Name"
+  copyright: "&copy; <%= Date.today.year %> Your Company Name"
 
   # url settings
   scheme: http
@@ -22,7 +25,7 @@ shared: &shared
 
   # mail settings
   smtp_domain: www.example.com
-  smtp_server: 
+  smtp_server:
   smtp_user_name:
   smtp_password:
 
@@ -30,19 +33,19 @@ shared: &shared
   info_email: info@example.com
   no_reply_email: noreply@example.com
   support_email: support@example.com
-  
+
 ##
-# Define settings per Rails environment, 
+# Define settings per Rails environment,
 # provide overrides to the shared settings as needed
 #
 development:
   # inherit shared settings
   <<: *shared
-  
+
   # url settings
   subdomain: dev
   domain: localhost:3000
-  
+
   # mail setting (for mailcatcher)
   smtp_server: localhost
   smtp_port: 1025

data/lib/generators/rails_simple_config/install/templates/secrets.yml

@@ -14,18 +14,18 @@
 shared: &shared
 
   ## E.g. Amazon key and secret
-  # s3_key: XXXXXXXXXXXXXXXXXXXX 
+  # s3_key: XXXXXXXXXXXXXXXXXXXX
   # s3_secret: 12345678901234567890ABCDEFGHIJKLMNOPQRST
   example: sekret!
 
 ##
-# Define settings per Rails environment, 
+# Define settings per Rails environment,
 # provide overrides to the shared settings as needed
 #
 development:
   # inherit shared settings
   <<: *shared
-  
+
 test:
   # inherit shared settings
   <<: *shared

data/lib/rails_simple_config/railtie.rb

@@ -12,7 +12,11 @@ module RailsSimpleConfig
     if Rails.env.development?
       initializer :load_simple_config_development do
         ActionController::Base.class_eval do
-          prepend_before_filter { ::SimpleConfig.reload! }
+          if Rails::VERSION::MAJOR >= 6 || (Rails::VERSION::MAJOR >= 5 && Rails::VERSION::MINOR >= 1)
+            prepend_before_action { ::SimpleConfig.reload! }
+          else
+            prepend_before_filter { ::SimpleConfig.reload! }
+          end
         end
       end
     end 

data/lib/rails_simple_config/version.rb

@@ -1,3 +1,3 @@
 module RailsSimpleConfig
-  VERSION = "0.0.3"
+  VERSION = "0.0.7"
 end

data/lib/rails_simple_config.rb

@@ -10,8 +10,8 @@ module SimpleConfig
 
     def load!
       puts "Loading configuration for '#{Rails.env}'."
-      load_file(Rails.root + 'secrets.yml')
-      load_file(Rails.root + 'config.yml')
+      load_file File.join(Rails.root, 'config', 'secrets.yml')
+      load_file File.join(Rails.root, 'config', 'config.yml')
     end
     
     def reload!
@@ -23,7 +23,7 @@ module SimpleConfig
     
     def load_file(filename)
       if File.exist?(filename)
-        configuration = YAML.load(ERB.new(File.read(filename)).result)[Rails.env]
+        configuration = YAML.load(ERB.new(File.read(filename)).result(binding))[Rails.env]
         configuration.each do |key, value|
           self.__send__("#{key}=", value)
         end if configuration
@@ -48,3 +48,5 @@ module SimpleConfig
 
 end
 
+# alias to support using AppConfig global
+AppConfig = SimpleConfig

data/rails_simple_config.gemspec

@@ -4,8 +4,8 @@ require "rails_simple_config/version"
 
 Gem::Specification.new do |s|
   s.name        = "rails_simple_config"
-  s.summary     = %q{Simple YAML based configuration gem for Rails 3+}
-  s.description = %q{A simple YAML based configuration for Ruby on Rails 3+, which supports shared settings, ERB and more.}
+  s.summary     = %q{Simple YAML based configuration gem for Rails}
+  s.description = %q{A simple YAML based configuration for Ruby on Rails, which supports shared settings, ERB and more.}
 
   s.authors     = ["Chris Stefano"]
   s.email       = ["virtualstaticvoid@gmail.com"]

metadata

@@ -1,25 +1,24 @@
 --- !ruby/object:Gem::Specification
 name: rails_simple_config
 version: !ruby/object:Gem::Version
-  version: 0.0.3
-  prerelease: 
+  version: 0.0.7
 platform: ruby
 authors:
 - Chris Stefano
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-09 00:00:00.000000000Z
+date: 2021-11-17 00:00:00.000000000 Z
 dependencies: []
-description: A simple YAML based configuration for Ruby on Rails 3+, which supports
-  shared settings, ERB and more.
+description: A simple YAML based configuration for Ruby on Rails, which supports shared
+  settings, ERB and more.
 email:
 - virtualstaticvoid@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - Gemfile.lock
 - MIT-LICENSE
@@ -35,26 +34,24 @@ files:
 - rails_simple_config.gemspec
 homepage: https://github.com/virtualstaticvoid/rails_simple_config
 licenses: []
+metadata: {}
 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: rails_simple_config
-rubygems_version: 1.8.6
+rubygems_version: 3.2.3
 signing_key: 
-specification_version: 3
-summary: Simple YAML based configuration gem for Rails 3+
+specification_version: 4
+summary: Simple YAML based configuration gem for Rails
 test_files: []