settings_on_rails 0.1.30

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1902e352d4b86e9b07fb40e0b3364a32ebf810f2
+  data.tar.gz: 0ff9fa4d7d46470da596aab09983f07415b58980
+SHA512:
+  metadata.gz: a23b884b80b9b6fc85920e42cc5b368a680176bd78e8e6910570ec6cf1b907bb39d42bc17f16523f99024a4994689f47b5b878a4a3a14bae5e13247543f700f8
+  data.tar.gz: 49efc61fc8d8f6efabdcfaee240db7f47032084c622fbf75ba79d4899385f6944326cf4de84a1a66d8cfa7d5c68caf77c7846e2555df543647498ee5fecc7a90

data/.gitignore

@@ -0,0 +1,11 @@
+/.idea/
+/bin/
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.1.0
+  - 2.2.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in settings_on_rails.gemspec
+gemspec
+
+gem 'coveralls', require: false
+

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 ALLEN WANG QIANG
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,102 @@
+# SettingsOnRails
+[![Build Status](https://travis-ci.org/allenwq/settings_on_rails.svg?branch=master)](https://travis-ci.org/allenwq/settings_on_rails)
+[![Coverage Status](https://coveralls.io/repos/allenwq/settings_on_rails/badge.svg?branch=master)](https://coveralls.io/r/allenwq/settings_on_rails?branch=master)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'settings_on_rails'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install settings_on_rails
+
+## Getting Started
+
+Start off by adding a text field to the model which you want it to have settings
+```ruby
+rails g migration add_settings_column_to_blogs settings_column:text
+
+```
+
+Declare in model
+```ruby
+class Blog < ActiveRecord::Base
+  has_settings_on :settings_column
+end
+```
+
+Set settings
+```ruby
+@blog.settings.title = 'My Blog'
+@blog.settings(:theme).background_color = 'blue'
+
+@blog.save
+```
+
+Get settings
+```ruby
+@blog.settings(:theme).background_color # returns 'blue'
+
+@blog.settings(:post).pagination # returns nil if not set
+
+```
+
+## Default Values
+
+```ruby
+class Blog < ActiveRecord::Base
+  has_settings_on :column
+
+  has_settings do |s|
+    s.has_key :theme, defaults:{ background_color: 'red', text_size: 50 }
+  end
+end
+```
+OR
+```ruby
+class Blog < ActiveRecord::Base
+  has_settings_on :column do |s|
+    s.define :theme, defaults:{ background_color: 'red', text_size: 50 }
+  end
+end
+```
+
+## Nested/Multiple Keys
+
+
+```ruby
+@blog.settings(:theme, :homepage).background_color = 'white'
+#OR
+@blog.settings(:theme).settings(:homepage).background_color = 'white'
+
+@blog.settings(:theme, :homepage).background_color # 'white'
+#OR
+@blog.settings(:theme).settings(:homepage).background_color # 'white'
+```
+
+## Method Name Customization
+You can customize the name of the settings method
+```ruby
+class Blog < ActiveRecord::Base
+  has_settings_on :settings_column, method: :preferences
+end
+
+# Then you can do
+@blog.preferences(:theme).background_color
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/allenwq/settings_on_rails/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`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/settings_on_rails/base.rb

@@ -0,0 +1,23 @@
+module SettingsOnRails
+  module Base
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def has_settings_on(column, options = {})
+        SettingsColumn.setup(self, column)
+
+        method_name = options[:method] || :settings
+        define_method method_name do |*keys|
+          column = SettingsColumn.check!(self)
+
+          SettingsHandler.new(keys, self, column, method_name)
+        end
+      end
+
+      def has_settings
+        raise NoSettingsColumnError unless SettingsColumn::NAME
+        yield if block_given?
+      end
+    end
+  end
+end

data/lib/settings_on_rails/exceptions.rb

@@ -0,0 +1,20 @@
+module SettingsOnRails
+
+  class NoSettingsColumnError < StandardError
+    def message
+      'settings column not specified, have you declared has_settings_on before?'
+    end
+  end
+
+  class ColumnNotExistError < StandardError
+    def message
+      'settings column does not exist, have you added the column in database?'
+    end
+  end
+
+  class InvalidColumnTypeError < StandardError
+    def message
+      'type of settings column must be text'
+    end
+  end
+end

data/lib/settings_on_rails/settings_column.rb

@@ -0,0 +1,32 @@
+module SettingsOnRails
+  module SettingsColumn
+    NAME = :__settings_column
+
+    def self.setup(klass, column)
+      klass.class_eval do
+        class << self; attr_accessor SettingsColumn::NAME; end
+
+        serialize column, Hash
+        self.send(SettingsColumn::NAME.to_s + '=', column.to_sym)
+      end
+    end
+
+    def self.column(instance)
+      instance.class.send(SettingsColumn::NAME)
+    end
+
+    def self.check!(instance)
+      settings_column = column(instance)
+      raise NoSettingsColumnError unless settings_column
+      raise ColumnNotExistError unless instance.has_attribute?(settings_column)
+      raise InvalidColumnTypeError if column_type_not_text?(instance, settings_column)
+
+      settings_column
+    end
+
+    private
+    def self.column_type_not_text?(instance, settings_column)
+      return true if instance.column_for_attribute(settings_column).try(:sql_type) != 'text'
+    end
+  end
+end

data/lib/settings_on_rails/settings_handler.rb

@@ -0,0 +1,118 @@
+module SettingsOnRails
+  class SettingsHandler
+    PREFIX = '_'
+
+    attr_accessor :keys, :parent
+    def initialize(keys, target_object, column, method_name, parent = nil)
+      @keys = _prefix(keys.dup)
+      @target_object = target_object
+      @column = column
+      @method_name = method_name
+      @parent = parent
+
+      self.class_eval do
+        define_method(method_name, instance_method(:_settings))
+      end
+    end
+
+    REGEX_SETTER = /\A([a-z]\w*)=\Z/i
+    REGEX_GETTER = /\A([a-z]\w*)\Z/i
+
+    def respond_to?(method_name, include_priv=false)
+      super || method_name.to_s =~ REGEX_SETTER
+    end
+
+    def method_missing(method_name, *args, &block)
+      if method_name.to_s =~ REGEX_SETTER && args.size == 1
+        _set_value($1, args.first)
+      elsif method_name.to_s =~ REGEX_GETTER && args.size == 0
+        _get_value($1)
+      else
+        super
+      end
+    end
+
+    private
+    def _settings(*keys)
+      raise ArgumentError, 'wrong number of arguments (0 for 1..n)' if keys.size == 0
+
+      SettingsHandler.new(keys, @target_object, @column, @method_name, self)
+    end
+
+    def _get_value(name)
+      node = _get_key_node
+
+      if node
+        node[name]
+      else
+        nil
+      end
+    end
+
+    def _set_value(name, v)
+      return if _get_value(name) == v
+
+      @target_object.send("#{@column}_will_change!")
+      _build_key_tree
+      node = _get_key_node
+      if v.nil?
+        node.delete(name)
+      else
+        node[name] = v
+      end
+    end
+
+    def _key_node_exist?
+      value = _target_column
+
+      for key in _key_chain
+          value = value[key]
+          return false unless value
+      end
+
+      true
+    end
+
+    def _get_key_node
+      ret = _key_node_exist?
+      return nil unless ret
+
+      _key_chain.inject(_target_column) { |h, key| h[key] }
+    end
+
+    def _build_key_tree
+      value = _target_column
+
+      for key in _key_chain
+        value[key] = {} unless value[key]
+        value = value[key]
+      end
+    end
+
+    def _target_column
+      @target_object.read_attribute(@column.to_sym)
+    end
+
+    # prefix keys with _, to differentiate `settings(:key_a, :key_b)` and settings(:key_a).key_b
+    # thus _ becomes an reserved field
+    def _prefix(keys)
+      for i in 0..(keys.length - 1)
+        keys[i] = (PREFIX + keys[i].to_s).to_sym
+      end
+      keys
+    end
+
+    # Returns a key chain which includes all parent's keys and self keys
+    def _key_chain
+      handler = self
+      key_chain = []
+
+      begin
+        key_chain = handler.keys + key_chain
+        handler = handler.parent
+      end while handler
+
+      key_chain
+    end
+  end
+end

data/lib/settings_on_rails/version.rb

@@ -0,0 +1,3 @@
+module SettingsOnRails
+  VERSION = '0.1.30'
+end

data/lib/settings_on_rails.rb

@@ -0,0 +1,7 @@
+require 'settings_on_rails/base'
+require 'settings_on_rails/settings_column'
+require 'settings_on_rails/settings_handler'
+require 'settings_on_rails/exceptions'
+require 'settings_on_rails/version'
+
+ActiveRecord::Base.send :include, SettingsOnRails::Base

data/settings_on_rails.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'settings_on_rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'settings_on_rails'
+  spec.version       = SettingsOnRails::VERSION
+  spec.authors       = ['ALLEN WANG QIANG']
+  spec.email         = ['qwang@comp.nus.edu.sg']
+
+  spec.summary       = %q{Handle Model specific Settings for Rails.}
+  spec.description   = %q{Ruby Gem help to handle model specific settings for ActiveRecord, settings are stored as hashes. Supports multiple keys and default values.}
+  spec.homepage      = 'https://github.com/allenwq/settings_on_rails'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 1.9'
+
+  spec.add_dependency 'activerecord', '>= 3.1'
+  spec.add_development_dependency 'sqlite3', '~> 1.3'
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rspec', '~> 3'
+  spec.add_development_dependency 'rake', '~> 10'
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: settings_on_rails
+version: !ruby/object:Gem::Version
+  version: 0.1.30
+platform: ruby
+authors:
+- ALLEN WANG QIANG
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-04-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+description: Ruby Gem help to handle model specific settings for ActiveRecord, settings
+  are stored as hashes. Supports multiple keys and default values.
+email:
+- qwang@comp.nus.edu.sg
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/settings_on_rails.rb
+- lib/settings_on_rails/base.rb
+- lib/settings_on_rails/exceptions.rb
+- lib/settings_on_rails/settings_column.rb
+- lib/settings_on_rails/settings_handler.rb
+- lib/settings_on_rails/version.rb
+- settings_on_rails.gemspec
+homepage: https://github.com/allenwq/settings_on_rails
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Handle Model specific Settings for Rails.
+test_files: []
+has_rdoc: