rails-settings-manager 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a70c010193fe02c5bf40d844c72d6e308e6b7d2a
+  data.tar.gz: 5dbf55864c160367484428233f0ec45add65554b
+SHA512:
+  metadata.gz: e2e1a5d2dc1af98ee279a555e8fb002d0efae686c4ea0a66a8f4ad4fa0d2487dcb064111359c69753717eb825d871e60d89cf1212512242e9fc0bf875364d61a
+  data.tar.gz: 595aa8994392a0d1207a9b0ce3ee63c492f0889068e84054a8d24b284a549b3729125849f687b26a596553a5a1a733847768f66ce401bbdc3bfae03a9f9d79fe

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Florian Nitschmann
+
+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,41 @@
+# Rails::Settings::Manager
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rails/settings/manager`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails-settings-manager'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails-settings-manager
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rails-settings-manager.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

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

@@ -0,0 +1,51 @@
+require "rails/generators"
+require "rails/generators/migration"
+
+module Settings
+  class InstallGenerator < Rails::Generators::NamedBase
+    include Rails::Generators::Migration
+
+    source_root File.expand_path("../templates", __FILE__)
+    desc "Installs migration, model and default file for settings"
+
+    argument :name, :type => :string, :default => "setting"
+
+    def main
+      @class_name = class_name
+      @default_config_file = "default_" + table_name + ".yml"
+      @migration_class_name = "Create" + table_name.camelize
+      @table_name = table_name
+
+      copy_migration
+      copy_model
+      copy_default_config
+    end
+
+    def self.next_migration_number(dirname)
+      if ActiveRecord::Base.timestamped_migrations
+        if Dir.glob(dirname + "/*.rb").any?
+          current_migration_number(dirname) + 1
+        else
+          Time.now.utc.strftime("%Y%m%d%H%M%S")
+        end
+      else
+        format("%.3d", current_migration_number(dirname) + 1)
+      end
+    end
+
+    private
+
+    def copy_default_config
+      template("default.yml", "config/#{@default_config_file}")
+    end
+
+    def copy_migration
+      migration_file = @migration_class_name.underscore + ".rb"
+      migration_template("migration.rb.erb", "db/migrate/#{migration_file}")
+    end
+
+    def copy_model
+      template("model.rb.erb", File.join("app/models", "#{file_path}.rb"))
+    end
+  end
+end

data/lib/generators/settings/install/templates/default.yml

@@ -0,0 +1,11 @@
+defaults: &defaults
+  foo: "bar"
+
+development:
+  <<: *defaults
+
+test:
+  <<: *defaults
+
+production:
+  <<: *defaults

data/lib/generators/settings/install/templates/migration.rb.erb

@@ -0,0 +1,16 @@
+class <%= @migration_class_name %> < ActiveRecord::Migration
+  def change
+    create_table :<%= @table_name %> do |t|
+      t.string  :key,           :null => false
+      t.text    :value,         :null => true
+      t.integer :base_obj_id,   :null => true
+      t.string  :base_obj_type, :null => true
+
+      t.timestamps :null => false
+    end
+
+    add_index :<%= @table_name %>, :key, :unique => true
+    add_index :<%= @table_name %>, :base_obj_id, :unique => true
+    add_index :<%= @table_name %>, :base_obj_type, :unique => true
+  end
+end

data/lib/generators/settings/install/templates/model.rb.erb

@@ -0,0 +1,6 @@
+require "settings-manager"
+
+class <%= @class_name %> < SettingsManager::Base
+  allowed_settings_keys []
+  default_settings_config Rails.root.join("config/<%= @default_config_file %>")
+end

data/lib/rails-settings-manager.rb

@@ -0,0 +1 @@
+require "settings-manager"

data/lib/settings-manager.rb

@@ -0,0 +1,4 @@
+module SettingsManager
+  require "settings-manager/base"
+  require "settings-manager/extension"
+end

data/lib/settings-manager/base.rb

@@ -0,0 +1,130 @@
+require "settings-manager/default"
+require "settings-manager/errors"
+require "settings-manager/validation"
+
+module SettingsManager
+  class Base < ActiveRecord::Base
+    include Default
+    include Validation
+
+    attr_reader :base_obj
+
+    self.abstract_class = true
+
+    def value
+      YAML.load(self[:value]) if self[:value].present?
+    end
+
+    def value=(new_value)
+      self[:value] = new_value.to_yaml
+    end
+
+    class << self
+      def [](key)
+        if key_allowed?(key)
+          object = object(key)
+
+          if object.present?
+            object.value
+          else
+            default_setting_for(key)
+          end
+        else
+          raise Errors::KeyInvalidError.new(key)
+        end
+      end
+
+      def []=(key, value)
+        key = key.to_s
+
+        unless key_allowed?(key)
+          raise Errors::KeyInvalidError.new(key)
+        end
+
+        attributes = { :key => key }
+
+        if @base_obj
+          attributes[:base_obj_id] = @base_obj.id
+          attributes[:base_obj_type] = @base_obj.class.base_class.to_s
+        end
+
+        record = object(key) || self.new(attributes)
+        record.value = value
+        record.save!
+
+        value
+      rescue ActiveRecord::RecordInvalid => e
+        new_exception = Errors::InvalidError.new
+        new_exception.errors << e.record.errors
+
+        raise new_exception
+      end
+
+      def destroy!(key)
+        record = object(key.to_s)
+
+        if record.present?
+          record.destroy!
+        else
+          raise Errors::SettingNotFoundError, "setting for `#{key.to_s}` not found"
+        end
+      end
+
+      def get_all
+        result = default_settings
+
+        base_query.each do |record|
+          result[record.key] = record.value
+        end
+
+        result
+      end
+
+      def method_missing(method, *args)
+        method_name = method.to_s
+        super(method, *args)
+      rescue NoMethodError => e
+        if method_name[-1] == "="
+          key = method_name.sub("=", "")
+          value = args.first
+
+          self[key] = value
+        else
+          self[method_name]
+        end
+      end
+
+      def object(key)
+        return nil unless Rails.application.initialized? && table_exists?
+
+        base_query.find_by(:key => key.to_s)
+      end
+
+      def set(settings = {})
+        ActiveRecord::Base.transaction do
+          exception = nil
+
+          settings.each do |key, value|
+            begin
+              self[key.to_s] = value
+            rescue Errors::KeyInvalidError => e
+              exception ||= Errors::InvalidError.new
+              exception.errors << e.message
+            rescue Errors::InvalidError => e
+              exception ||= Errors::InvalidError.new
+              e.errors.each { |error| exception.errors << error }
+            end
+          end
+
+          raise exception if exception.present?
+        end
+
+        self.get_all
+      end
+
+      def base_query
+        where(:base_obj_id => nil, :base_obj_type => nil)
+      end
+    end
+  end
+end

data/lib/settings-manager/default.rb

@@ -0,0 +1,25 @@
+module SettingsManager
+  module Default
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def default_settings
+        file = @default_settings_config_path
+
+        if file && ::File.exist?(file)
+          YAML.load_file(file)[Rails.env] || {}
+        else
+          {}
+        end
+      end
+
+      def default_settings_config(path = nil)
+        @default_settings_config_path = path
+      end
+
+      def default_setting_for(key)
+        default_settings[key.to_s]
+      end
+    end
+  end
+end

data/lib/settings-manager/errors.rb

@@ -0,0 +1,50 @@
+module SettingsManager
+  module Errors
+    class BaseError < StandardError ; end
+    class SettingNotFoundError < BaseError ; end
+
+    class InvalidError < BaseError
+      class ComplexErrorArray < Array
+        def <<(obj)
+          unless obj.is_a?(String) || obj.is_a?(ActiveModel::Errors)
+            raise ArgumentError
+          end
+
+          super
+        end
+
+        def messages
+          messages = []
+
+          self.each do |message|
+            if message.is_a?(String)
+              messages << message
+            elsif message.is_a?(ActiveModel::Errors)
+              message.full_messages.each { |m| messages << m }
+            end
+          end
+
+          messages.uniq
+        end
+      end
+
+      attr_reader :errors
+
+      def initialize
+        @errors = ComplexErrorArray.new
+      end
+    end
+
+    class KeyInvalidError < BaseError
+      attr_reader :key
+
+      def initialize(key = nil)
+        @key = key || ""
+      end
+
+      def message
+        "unallowed key `#{@key}`"
+      end
+    end
+  end
+end

data/lib/settings-manager/extension.rb

@@ -0,0 +1,41 @@
+require "settings-manager/extension/scopes"
+
+module SettingsManager
+  module Extension
+    extend ActiveSupport::Concern
+
+    include Scopes
+
+    def settings
+      base_class = self.class.settings_base_class.to_s.constantize
+
+      wrapped_class = base_class.clone
+      wrapped_class.instance_variable_set(:@base_obj, self)
+
+      wrapped_class.instance_eval do
+        def base_query
+          where(
+            :base_obj_id => @base_obj.id,
+            :base_obj_type => @base_obj.class.base_class.to_s
+          )
+        end
+
+        def model_name
+          @base_obj.class.settings_base_class.to_s.constantize.model_name
+        end
+      end
+
+      wrapped_class
+    end
+
+    module ClassMethods
+      def settings_base_class(class_name = nil)
+        if class_name.present?
+          @settings_base_class = class_name.to_s
+        else
+          @settings_base_class || "Setting"
+        end
+      end
+    end
+  end
+end

data/lib/settings-manager/extension/scopes.rb

@@ -0,0 +1,59 @@
+module SettingsManager
+  module Extension
+    module Scopes
+      extend ActiveSupport::Concern
+
+      included do
+        scope :with_settings, lambda {
+          class_name = self.base_class.to_s
+          settings_table = self.settings_base_class.to_s.constantize.table_name
+          table = self.table_name
+
+          joins("INNER JOIN #{settings_table} ON (
+                  #{settings_table}.base_obj_id = #{table}.#{primary_key} AND
+                  #{settings_table}.base_obj_type = '#{class_name}'
+                )")
+            .select("DISTINCT #{table}.*")
+
+        }
+
+        scope :with_settings_for, lambda { |var|
+          class_name = self.base_class.to_s
+          settings_table = self.settings_base_class.to_s.constantize.table_name
+          table = self.table_name
+
+          joins("INNER JOIN #{settings_table} ON (
+                  #{settings_table}.base_obj_id = #{table}.#{primary_key} AND
+                  #{settings_table}.base_obj_type = '#{class_name}' AND
+                  #{settings_table}.key = '#{var.to_s}'
+                )")
+        }
+
+        scope :without_settings, lambda {
+          class_name = self.base_class.to_s
+          settings_table = self.settings_base_class.to_s.constantize.table_name
+          table = self.table_name
+
+          joins("LEFT JOIN #{settings_table} ON (
+                  #{settings_table}.base_obj_id = #{table}.#{primary_key} AND
+                  #{settings_table}.base_obj_type = '#{class_name}'
+                )")
+            .where("#{settings_table}.id IS NULL")
+        }
+
+        scope :without_settings_for, lambda { |var|
+          class_name = self.base_class.to_s
+          settings_table = self.settings_base_class.to_s.constantize.table_name
+          table = self.table_name
+
+          where("#{settings_table}.id IS NULL")
+            .joins("LEFT JOIN #{settings_table} ON (
+                    #{settings_table}.base_obj_id = #{table}.#{primary_key} AND
+                    #{settings_table}.base_obj_type = '#{class_name}' AND
+                    #{settings_table}.key = '#{var.to_s}'
+                  )")
+        }
+      end
+    end
+  end
+end

data/lib/settings-manager/validation.rb

@@ -0,0 +1,42 @@
+module SettingsManager
+  module Validation
+    extend ActiveSupport::Concern
+
+    included do
+      validates_inclusion_of :key,
+        in: ->(r) { r.class.allowed_settings_keys.map { |k| k.to_s } },
+        if: Proc.new { |r| r.class.allowed_settings_keys.any? },
+        message: "`%{value}` is an unallowed setting"
+
+      validates_uniqueness_of :base_obj_id,
+        :scope => [:key, :base_obj_type]
+    end
+
+    def allowed_settings_keys
+      self.class.allowed_settings_keys
+    end
+
+    module ClassMethods
+      def allowed_settings_keys(keys = nil)
+        if keys.present? && keys.kind_of?(Array)
+          @allowed_settings_keys = keys
+        else
+          @allowed_settings_keys || []
+        end
+      end
+
+      def key_allowed?(key)
+        if allowed_settings_keys.any?
+          allowed_settings_keys.include?(key.to_sym)
+        else
+          true
+        end
+      end
+
+      def validates_setting(value, options = {})
+        options[:if] = Proc.new { |record| value.to_s == record.key.to_s }
+        validates(:value, options)
+      end
+    end
+  end
+end

data/lib/settings-manager/version.rb

@@ -0,0 +1,3 @@
+module SettingsManager
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: rails-settings-manager
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Florian Nitschmann
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: pry-rails
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: "\n  A simple extension-plugin for Ruby on Rails application for global
+  settings management in the Database with an easy key-value interface.\n  It keeps
+  track of the settings with the help of standard ActiveRecord methods.\n  "
+email:
+- f.nitschmann@googlemail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/generators/settings/install/install_generator.rb
+- lib/generators/settings/install/templates/default.yml
+- lib/generators/settings/install/templates/migration.rb.erb
+- lib/generators/settings/install/templates/model.rb.erb
+- lib/rails-settings-manager.rb
+- lib/settings-manager.rb
+- lib/settings-manager/base.rb
+- lib/settings-manager/default.rb
+- lib/settings-manager/errors.rb
+- lib/settings-manager/extension.rb
+- lib/settings-manager/extension/scopes.rb
+- lib/settings-manager/validation.rb
+- lib/settings-manager/version.rb
+homepage: https://github.com/fnitschmann/rails-settings-manager
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Global settings management for Rails applications with ActiveRecord
+test_files: []