rails-settings-cached 0.5.4 → 0.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 573145ca5a45516e138312ff9b35338e97b2a12b
-  data.tar.gz: 4e55fec2760056d075ae1cd330d5d26cc6cd7a0b
+  metadata.gz: caebc0d7ac88a78fec43016475b3ed2e9e22a730
+  data.tar.gz: 05861d98bbece04178fec89687f2310a42a31194
 SHA512:
-  metadata.gz: 5844cac704005e2d797f1e6d9bcd770f480f84f3ee5eba29aae25f4a0e67466863ff14cdd94b2e95e955a5a07a8d19c85b31cfdb7318f141b42772e877147e03
-  data.tar.gz: f9dcf649734ed373921eaab2fee33257beb68e785841268c4eba98c1bb610172647bec696dd911a70f489852fc30bfe1aee1bf0f46c3065018f68c9d2ee66048
+  metadata.gz: 3c814d540d0f548744d4c10ced5de27142b56f4d50519ab33e7b9b8435d11970ee1cf6fce0f747df8ac33e9ecd64a115e105267e569055ae430d66e6608c1b72
+  data.tar.gz: f2f7b6c1ce43c34f6917a5ad9396d40735093fd06778d891c74c0cf6f4062ebcc3ee4aa5f833dc42926b2c11eccbd3e2ae9fe533daf42d470e305abea14e7b9e

data/README.md

@@ -9,13 +9,17 @@ of object. Strings, numbers, arrays, or any object.
 
 ## Status
 
-[![Gem Version](https://badge.fury.io/rb/rails-settings-cached.svg)](https://rubygems.org/gems/rails-settings-cached) [![CI Status](https://api.travis-ci.org/huacnlee/rails-settings-cached.svg)](http://travis-ci.org/huacnlee/rails-settings-cached)
+[![Gem Version](https://badge.fury.io/rb/rails-settings-cached.svg)](https://rubygems.org/gems/rails-settings-cached) [![CI Status](https://api.travis-ci.org/huacnlee/rails-settings-cached.svg)](http://travis-ci.org/huacnlee/rails-settings-cached) [![Code Climate](https://codeclimate.com/github/huacnlee/rails-settings-cached/badges/gpa.svg)](https://codeclimate.com/github/huacnlee/rails-settings-cached) [![codecov.io](https://codecov.io/github/huacnlee/rails-settings-cached/coverage.svg?branch=master)](https://codecov.io/github/huacnlee/rails-settings-cached?branch=master)
 
 ## Setup
 
 Edit your Gemfile:
 
 ```ruby
+# Rails 5.0.x
+gem 'rails-settings-cached', '~> 0.6.0'
+# Rails 4.2.x
+gem 'rails-settings-cached', "~> 0.5.4"
 # Rails 4.1.x
 gem "rails-settings-cached", "~> 0.4.0"
 # Rails 4+
@@ -27,15 +31,13 @@ gem "rails-settings-cached", "0.2.4"
 Generate your settings:
 
 ```bash
-$ rails g settings <settings_name>
+$ rails g settings:install
 ```
 
-Note: If you migrating from gem `rails-settings` then make sure you have it in your model
+If you want custom model name:
 
-```ruby
-class Settings < RailsSettings::CachedSettings
-  ...
-end
+```bash
+$ rails g settings:install MySetting
 ```
 
 Now just put that migration in the database with:

data/lib/generators/settings/install_generator.rb

@@ -0,0 +1,33 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module Settings
+  class InstallGenerator < Rails::Generators::NamedBase
+    desc "Generate RailsSettings files."
+    include Rails::Generators::Migration
+
+    argument :name, type: :string, default: 'setting'
+
+    source_root File.expand_path('../templates', __FILE__)
+
+    @@migrations = false
+
+    def self.next_migration_number(dirname) #:nodoc:
+      if ActiveRecord::Base.timestamped_migrations
+        if @@migrations
+          (current_migration_number(dirname) + 1)
+        else
+          @@migrations = true
+          Time.now.utc.strftime('%Y%m%d%H%M%S')
+        end
+      else
+        format '%.3d', current_migration_number(dirname) + 1
+      end
+    end
+
+    def install_setting
+      template 'model.rb', File.join('app/models', class_path, "#{file_name}.rb"), force: true
+      migration_template 'migration.rb', 'db/migrate/create_settings.rb'
+    end
+  end
+end

data/lib/rails-settings-cached.rb

@@ -1,11 +1,15 @@
+require_relative 'rails-settings/base'
 require_relative 'rails-settings/settings'
 require_relative 'rails-settings/cached_settings'
 require_relative 'rails-settings/scoped_settings'
 require_relative 'rails-settings/extend'
+require_relative 'rails-settings/version'
 
-class RailsSettings::Railtie < Rails::Railtie
-  initializer "rails_settings.active_record.initialization" do
-    RailsSettings::CachedSettings.after_commit :rewrite_cache, on: %i(create update)
-    RailsSettings::CachedSettings.after_commit :expire_cache, on: %i(destroy)
+module RailsSettings
+  class Railtie < Rails::Railtie
+    initializer "rails_settings.active_record.initialization" do
+      RailsSettings::CachedSettings.after_commit :rewrite_cache, on: %i(create update)
+      RailsSettings::CachedSettings.after_commit :expire_cache, on: %i(destroy)
+    end
   end
 end

data/lib/rails-settings/base.rb

@@ -0,0 +1,112 @@
+module RailsSettings
+  class Base < ActiveRecord::Base
+    self.table_name = table_name_prefix + 'settings'
+
+    class SettingNotFound < RuntimeError; end
+
+    cattr_accessor :defaults
+    @@defaults = {}.with_indifferent_access
+
+    belongs_to :thing, polymorphic: true
+
+    # Support old plugin
+    if defined?(SettingsDefaults::DEFAULTS)
+      @@defaults = SettingsDefaults::DEFAULTS.with_indifferent_access
+    end
+
+    # get the value field, YAML decoded
+    def value
+      YAML.load(self[:value]) if self[:value].present?
+    end
+
+    # set the value field, YAML encoded
+    def value=(new_value)
+      self[:value] = new_value.to_yaml
+    end
+
+    class << self
+      # get or set a variable with the variable as the called method
+      def method_missing(method, *args)
+        method_name = method.to_s
+        super(method, *args)
+      rescue NoMethodError
+        # set a value for a variable
+        if method_name[-1] == '='
+          var_name = method_name.sub('=', '')
+          value = args.first
+          self[var_name] = value
+        else
+          # retrieve a value
+          self[method_name]
+        end
+      end
+
+      # destroy the specified settings record
+      def destroy(var_name)
+        var_name = var_name.to_s
+        obj = object(var_name)
+        raise SettingNotFound, "Setting variable \"#{var_name}\" not found" if obj.nil?
+
+        obj.destroy
+        true
+      end
+
+      # retrieve all settings as a hash (optionally starting with a given namespace)
+      def get_all(starting_with = nil)
+        vars = thing_scoped.select('var, value')
+        vars = vars.where("var LIKE '#{starting_with}%'") if starting_with
+
+        result = {}
+        vars.each do |record|
+          result[record.var] = record.value
+        end
+        default_keys = @@defaults.keys
+        default_keys = default_keys.select {|k| k.start_with? starting_with } if starting_with
+        result.merge! @@defaults.slice(*(default_keys - result.keys))
+
+        result.with_indifferent_access
+      end
+
+      def where(sql = nil)
+        vars = thing_scoped.where(sql) if sql
+        vars
+      end
+
+      # get a setting value by [] notation
+      def [](var_name)
+        object(var_name).try(:value) || @@defaults[var_name.to_s]
+      end
+
+      # set a setting value by [] notation
+      def []=(var_name, value)
+        var_name = var_name.to_s
+
+        record = object(var_name) || thing_scoped.new(var: var_name)
+        record.value = value
+        record.save!
+
+        value
+      end
+
+      def merge!(var_name, hash_value)
+        raise ArgumentError unless hash_value.is_a?(Hash)
+
+        old_value = self[var_name] || {}
+        raise TypeError, "Existing value is not a hash, can't merge!" unless old_value.is_a?(Hash)
+
+        new_value = old_value.merge(hash_value)
+        self[var_name] = new_value if new_value != old_value
+
+        new_value
+      end
+
+      def object(var_name)
+        thing_scoped.where(var: var_name.to_s).first
+      end
+
+      def thing_scoped
+        unscoped.where('thing_type is NULL and thing_id is NULL')
+      end
+    end
+  end
+end

data/lib/rails-settings/settings.rb

@@ -1,112 +1,9 @@
 module RailsSettings
-  class Settings < ActiveRecord::Base
-    self.table_name = table_name_prefix + 'settings'
-
-    class SettingNotFound < RuntimeError; end
-
-    cattr_accessor :defaults
-    @@defaults = {}.with_indifferent_access
-
-    belongs_to :thing, polymorphic: true
-
-    # Support old plugin
-    if defined?(SettingsDefaults::DEFAULTS)
-      @@defaults = SettingsDefaults::DEFAULTS.with_indifferent_access
-    end
-
-    # get the value field, YAML decoded
-    def value
-      YAML.load(self[:value]) if self[:value].present?
-    end
-
-    # set the value field, YAML encoded
-    def value=(new_value)
-      self[:value] = new_value.to_yaml
-    end
-
-    class << self
-      # get or set a variable with the variable as the called method
-      def method_missing(method, *args)
-        method_name = method.to_s
-        super(method, *args)
-      rescue NoMethodError
-        # set a value for a variable
-        if method_name[-1] == '='
-          var_name = method_name.sub('=', '')
-          value = args.first
-          self[var_name] = value
-        else
-          # retrieve a value
-          self[method_name]
-        end
-      end
-
-      # destroy the specified settings record
-      def destroy(var_name)
-        var_name = var_name.to_s
-        obj = object(var_name)
-        raise SettingNotFound, "Setting variable \"#{var_name}\" not found" if obj.nil?
-
-        obj.destroy
-        true
-      end
-
-      # retrieve all settings as a hash (optionally starting with a given namespace)
-      def get_all(starting_with = nil)
-        vars = thing_scoped.select('var, value')
-        vars = vars.where("var LIKE '#{starting_with}%'") if starting_with
-
-        result = {}
-        vars.each do |record|
-          result[record.var] = record.value
-        end
-        default_keys = @@defaults.keys
-        default_keys = default_keys.select {|k| k.start_with? starting_with } if starting_with
-        result.merge! @@defaults.slice(*(default_keys - result.keys))
-
-        result.with_indifferent_access
-      end
-
-      def where(sql = nil)
-        vars = thing_scoped.where(sql) if sql
-        vars
-      end
-
-      # get a setting value by [] notation
-      def [](var_name)
-        object(var_name).try(:value) || @@defaults[var_name.to_s]
-      end
-
-      # set a setting value by [] notation
-      def []=(var_name, value)
-        var_name = var_name.to_s
-
-        record = object(var_name) || thing_scoped.new(var: var_name)
-        record.value = value
-        record.save!
-
-        value
-      end
-
-      def merge!(var_name, hash_value)
-        raise ArgumentError unless hash_value.is_a?(Hash)
-
-        old_value = self[var_name] || {}
-        raise TypeError, "Existing value is not a hash, can't merge!" unless old_value.is_a?(Hash)
-
-        new_value = old_value.merge(hash_value)
-        self[var_name] = new_value if new_value != old_value
-
-        new_value
-      end
-
-      def object(var_name)
-        thing_scoped.where(var: var_name.to_s).first
-      end
-
-      def thing_scoped
-        unscoped.where('thing_type is NULL and thing_id is NULL')
-      end
+  class Settings < Base
+    def self.inherited(subclass)
+      Kernel.warn 'DEPRECATION WARNING: RailsSettings::Settings is deprecated and it will removed in 0.6.0. ' <<
+                  'Please use RailsSettings::Base instead.'
+      super(subclass)
     end
   end
 end

data/lib/rails-settings/version.rb

@@ -0,0 +1,7 @@
+module RailsSettings
+  class << self
+    def version
+      "0.5.5"
+    end
+  end
+end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: rails-settings-cached
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.5.5
 platform: ruby
 authors:
+- Jason Lee
 - Squeegy
 - Georg Ledermann
 - 100hz
-- Jason Lee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-10 00:00:00.000000000 Z
+date: 2016-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -27,77 +27,28 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.2.0
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.3.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.3.0
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.3.10
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.3.10
-description: 
+description: "\n  This is improved from rails-settings, added caching.\n  Settings
+  plugin for Rails that makes managing a table of global key,\n  value pairs easy.
+  Think of it like a global Hash stored in you database,\n  that uses simple ActiveRecord
+  like methods for manipulation.\n\n  Keep track of any global setting that you dont
+  want to hard code into your rails app.\n  You can store any kind of object.  Strings,
+  numbers, arrays, or any object.\n  "
 email: huacnlee@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - README.md
-- lib/generators/settings/settings_generator.rb
+- lib/generators/settings/install_generator.rb
 - lib/generators/settings/templates/migration.rb
 - lib/generators/settings/templates/model.rb
 - lib/rails-settings-cached.rb
+- lib/rails-settings/base.rb
 - lib/rails-settings/cached_settings.rb
 - lib/rails-settings/extend.rb
 - lib/rails-settings/scoped_settings.rb
 - lib/rails-settings/settings.rb
+- lib/rails-settings/version.rb
 homepage: https://github.com/huacnlee/rails-settings-cached
 licenses: []
 metadata: {}
@@ -109,7 +60,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -117,13 +68,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.2
 signing_key: 
 specification_version: 4
-summary: This is improved from rails-settings, added caching. Settings is a plugin
-  that makes managing a table of global key, value pairs easy. Think of it like a
-  global Hash stored in you database, that uses simple ActiveRecord like methods for
-  manipulation.  Keep track of any global setting that you dont want to hard code
-  into your rails app.  You can store any kind of object.  Strings, numbers, arrays,
-  or any object. Ported to Rails 3!
+summary: Settings plugin for Rails that makes managing a table of global keys.
 test_files: []

data/lib/generators/settings/settings_generator.rb

@@ -1,30 +0,0 @@
-require 'rails/generators/migration'
-
-class SettingsGenerator < Rails::Generators::NamedBase
-  include Rails::Generators::Migration
-
-  argument :name, type: :string, default: 'my_settings'
-
-  source_root File.expand_path('../templates', __FILE__)
-
-  @@migrations = false
-
-  def self.next_migration_number(dirname) #:nodoc:
-    if ActiveRecord::Base.timestamped_migrations
-      if @@migrations
-        (current_migration_number(dirname) + 1)
-      else
-        @@migrations = true
-        Time.now.utc.strftime('%Y%m%d%H%M%S')
-      end
-    else
-      format '%.3d', current_migration_number(dirname) + 1
-    end
-  end
-
-  def settings
-    # generate(:model, name, "--skip-migration")
-    template 'model.rb', File.join('app/models', class_path, "#{file_name}.rb"), force: true
-    migration_template 'migration.rb', 'db/migrate/create_settings.rb'
-  end
-end