smart_settings 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6c8402e60d1de130708fb6ea8717e2e2eb6304fa
+  data.tar.gz: 5a6f0e458d3e251844703d84faae453bf5bc3730
+SHA512:
+  metadata.gz: 74a9905cd957703efbef0e0732be4b95d3097ac9fa4ac861acedb4027d3cc2e7fdc71871280951bc2d7a8cff9fa0e516e894413e1dbff7090bec592355401733
+  data.tar.gz: 8acebc30ba8e4b587b7c86c173b3e1125dfdedbc3119bb0162152c22fcaadcfd0bf14575175a536b78a8c0b24b56d757f08e77244f6c2b8d36fe00de983e0edc

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at info@hardpixel.eu. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in smart_settings.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,44 @@
+PATH
+  remote: .
+  specs:
+    smart_settings (0.1.0)
+      activerecord (~> 5.0)
+      tableless (~> 0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.1.4)
+      activesupport (= 5.1.4)
+    activerecord (5.1.4)
+      activemodel (= 5.1.4)
+      activesupport (= 5.1.4)
+      arel (~> 8.0)
+    activesupport (5.1.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (8.0.0)
+    concurrent-ruby (1.0.5)
+    i18n (0.9.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.10.3)
+    rake (10.5.0)
+    tableless (0.1.0)
+      activerecord (~> 5.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.3)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.14)
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  smart_settings!
+
+BUNDLED WITH
+   1.15.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Jonian Guveli
+
+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,133 @@
+# SmartSettings
+
+Stores and retrieves settings on an ActiveRecord class, with support for application and per record settings.
+
+[![Gem Version](https://badge.fury.io/rb/smart_settings.svg)](https://badge.fury.io/rb/smart_settings)
+[![Build Status](https://travis-ci.org/hardpixel/smart-settings.svg?branch=master)](https://travis-ci.org/hardpixel/smart-settings)
+[![Maintainability](https://api.codeclimate.com/v1/badges/930d42bb2bf6f54a4268/maintainability)](https://codeclimate.com/github/hardpixel/smart-settings/maintainability)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'smart_settings'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install smart_settings
+
+Then run the settings generator that will create a migration and a `Setting` model:
+
+    rails g smart_settings:install
+
+And finally run the migrations:
+
+    rails db:migrate
+
+## Usage
+
+To create an new setting you can use the setting generator. The format of the generator arguments is `name attribute:type:default:group`. To generate a setting with the name email:
+
+    rails g smart_settings:setting email sender:string:info@website.com domain:string:website.com:smtp user:string:smtp@website.com:smtp password:string::smtp
+
+The command above will generate the `EmailSettings` class inside the `app/settings` folder:
+
+```ruby
+class EmailSettings < SmartSettings::Base
+  setting :sender,   :string, default: 'info@website.com'
+  setting :domain,   :string, default: 'website.com',      group: :smtp
+  setting :user,     :string, default: 'smtp@website.com', group: :smtp
+  setting :password, :string, group: :smtp
+end
+```
+
+Then you can use the `Setting` model or the `EmailSettings` class to get and set attributes:
+
+```ruby
+# Get email settings using the Setting model
+email = Setting.find(:email)
+
+# Get email settings using EmailSettings class
+email = EmailSettings
+
+# Get all setting attributes
+email.all  # { sender: "info@website.com", smtp: { domain: "website.com", user: "smtp@website.com", password: nil } }
+
+# Get all setting group attributes
+email.smtp # { domain: "website.com", user: "smtp@website.com", password: nil }
+
+# Get setting specific attributes
+email.sender    # "info@website.com"
+email.smtp_user # "smtp@website.com"
+
+# Update setting attributes and save them in the settings table
+email.update sender: "notify@website.com", smtp_user: "admin@website.com"
+
+# Get setting updated attributes
+email.sender    # "notify@website.com"
+email.smtp_user # "admin@website.com"
+```
+
+The `Setting` model that is created with the install generator and the settings classes the are created with the setting generator, use the [tableless](https://github.com/hardpixel/tableless) gem to act like ActiveRecord models. This makes it easy to create CRUD controllers and views like you would do with any model:
+
+```ruby
+class SettingsController < ApplicationController
+  # Show and edit actions are omitted from the example since they usually are empty
+  # New and create actions cannot be used since you cannot create new settings
+
+  before_action :set_setting, only: [:show, :edit, :update, :destroy]
+
+  def index
+    @setting = Setting.all
+  end
+
+  def update
+    if @setting.update(setting_params)
+      redirect_to setting_path(@setting), notice: 'Setting was successfully updated.'
+    else
+      render :edit
+    end
+  end
+
+  def destroy
+    @setting.destroy
+    redirect_to request.referrer, notice: 'Setting was successfully reset to defaults.'
+  end
+
+  private
+
+    def set_setting
+      @setting = Setting.find(params[:id])
+    end
+
+    def setting_params
+      params.require(:setting).permit(@setting.permitted_attributes)
+    end
+end
+```
+
+# TODO
+
+* Add support for record settings
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hardpixel/smart-settings. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the SmartSettings project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/hardpixel/smart-settings/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/lib/generators/smart_settings/install_generator.rb

@@ -0,0 +1,21 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+require 'rails/generators/active_record'
+
+module SmartSettings
+  class InstallGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+
+    desc 'Generates migrations to add settings tables.'
+    source_root File.expand_path('../templates', __FILE__)
+
+    def create_migration_file
+      template 'model.rb', 'app/models/setting.rb'
+      migration_template 'migration.rb', 'db/migrate/create_settings.rb'
+    end
+
+    def self.next_migration_number(dirname)
+      ::ActiveRecord::Generators::Base.next_migration_number(dirname)
+    end
+  end
+end

data/lib/generators/smart_settings/setting_generator.rb

@@ -0,0 +1,42 @@
+require 'rails/generators'
+
+module SmartSettings
+  class SettingGenerator < Rails::Generators::Base
+
+    desc 'Generates a new setting class in settings folder.'
+    source_root File.expand_path('../templates', __FILE__)
+
+    argument :name, type: :string, required: true
+
+    def create_migration_file
+      template 'setting.rb', "app/settings/#{setting_file}.rb"
+    end
+
+    private
+
+      def setting_class
+        name.camelize
+      end
+
+      def setting_file
+        "#{name.downcase.underscore}_settings"
+      end
+
+      def setting_fields
+        args.map do |arg|
+          field, cast_type, default, group = arg.split(':')
+
+          items  = [":#{field.to_sym}", ":#{cast_type.to_sym}"]
+          items << ["default: #{value_type_cast(cast_type.to_sym, default)}"] if default.present?
+          items << ["group: :#{group.to_sym}"] if group.present?
+
+          items.join(', ')
+        end
+      end
+
+      def value_type_cast(cast_type, value)
+        strings = [:string, :date, :datetime, :time]
+        cast_type.in?(strings) ? "'#{value}'" : value
+      end
+  end
+end

data/lib/generators/smart_settings/templates/migration.rb

@@ -0,0 +1,14 @@
+class CreateSettings < ActiveRecord::Migration[5.0]
+  def change
+    create_table :settings do |t|
+      t.string  :var, null: false
+      t.string  :value
+      t.integer :settable_id
+      t.string  :settable_type, null: false
+
+      t.timestamps
+    end
+
+    add_index :settings, [:settable_id, :settable_type, :var], unique: true
+  end
+end

data/lib/generators/smart_settings/templates/model.rb

@@ -0,0 +1,2 @@
+class Setting < SmartSettings::Base
+end

data/lib/generators/smart_settings/templates/setting.rb

@@ -0,0 +1,5 @@
+class <%= setting_class %>Settings < SmartSettings::Base
+  <%- setting_fields.each do |field| -%>
+  setting <%= field %>
+  <%- end -%>
+end

data/lib/smart_settings.rb

@@ -0,0 +1,11 @@
+require 'active_support'
+require 'smart_settings/version'
+require 'smart_settings/naming'
+require 'smart_settings/attributes'
+require 'smart_settings/querying'
+require 'smart_settings/persistence'
+require 'smart_settings/base'
+require 'smart_settings/setting'
+
+module SmartSettings
+end

data/lib/smart_settings/attributes.rb

@@ -0,0 +1,57 @@
+module SmartSettings
+  module Attributes
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :setting_names
+      class_attribute :setting_groups
+
+      self.setting_names  = []
+      self.setting_groups = {}
+    end
+
+    class_methods do
+      def setting(name, type_cast=:string, options={})
+        gname = options.delete(:group)
+        sname = gname.nil? ? name : :"#{gname}_#{name}"
+
+        attribute sname, type_cast, options
+        self.setting_names += [sname]
+
+        unless gname.nil?
+          group = setting_groups.fetch(gname, []) + [sname]
+          self.setting_groups = setting_groups.merge(gname => group)
+        end
+      end
+
+      def method_missing(method, *args, &block)
+        setting_names.any? ? new.send(method, *args, &block) : super
+      end
+    end
+
+    def all
+      except = setting_groups.values.flatten + [:var]
+      single = attributes.symbolize_keys.except(*except)
+      groups = Hash[setting_groups.keys.map { |s| [s, group(s)] }]
+
+      single.merge(groups)
+    end
+
+    def group_exists?(name)
+      setting_groups.keys.include? name
+    end
+
+    def group(name)
+      if group_exists?(name)
+        keys = setting_groups[name]
+        data = attributes.symbolize_keys.select { |k, _v| k.in? keys }
+
+        Hash[data.map { |k, v| [k.to_s.sub("#{name}_", '').to_sym, v] }]
+      end
+    end
+
+    def method_missing(method, *args, &block)
+      group_exists?(method) ? group(method) : super
+    end
+  end
+end

data/lib/smart_settings/base.rb

@@ -0,0 +1,12 @@
+require 'tableless'
+
+module SmartSettings
+  class Base < ActiveRecord::Base
+    include Tableless
+
+    include SmartSettings::Naming
+    include SmartSettings::Attributes
+    include SmartSettings::Querying
+    include SmartSettings::Persistence
+  end
+end

data/lib/smart_settings/naming.rb

@@ -0,0 +1,31 @@
+module SmartSettings
+  module Naming
+    extend ActiveSupport::Concern
+
+    included do
+      attribute :var, :string
+    end
+
+    class_methods do
+      def model_name
+        ActiveModel::Name.new(self, nil, 'Setting')
+      end
+
+      def permitted_attributes
+        attribute_names
+      end
+    end
+
+    def var
+      "#{self.class.name}".demodulize.sub('Settings', '')
+    end
+
+    def to_param
+      "#{var}".parameterize
+    end
+
+    def permitted_attributes
+      attribute_names - ['var']
+    end
+  end
+end

data/lib/smart_settings/persistence.rb

@@ -0,0 +1,59 @@
+module SmartSettings
+  module Persistence
+    extend ActiveSupport::Concern
+
+    included do
+      after_initialize do
+        self.var = var
+
+        settings.each do |setting|
+          svar, value = [setting.var, setting.value]
+          send(:"#{svar}=", cast_setting_value(svar, value))
+        end
+
+        @_suspend_save_callbacks = true
+        self.save
+        @_suspend_save_callbacks = false
+      end
+
+      before_save do
+        unless @_suspend_save_callbacks
+          changes_to_save.each do |var, value|
+            create_or_update_setting(var, value.last)
+          end
+        end
+      end
+
+      before_destroy do
+        settings.destroy_all
+      end
+    end
+
+    def settings
+      Setting.where(settable_type: self.class.name, settable_id: id)
+    end
+
+    private
+
+      def cast_setting_value(var, value)
+        self.class.attribute_types[var].cast(value)
+      end
+
+      def create_setting(var, value)
+        parameters = { var: var, value: cast_setting_value(var, value) }
+        Setting.create(parameters.merge(settable_type: self.class.name, settable_id: id))
+      end
+
+      def update_setting(var, value)
+        settings.where(var: var).update(value: cast_setting_value(var, value))
+      end
+
+      def create_or_update_setting(var, value)
+        if settings.where(var: var).exists?
+          update_setting(var, value)
+        else
+          create_setting(var, value)
+        end
+      end
+  end
+end

data/lib/smart_settings/querying.rb

@@ -0,0 +1,63 @@
+module SmartSettings
+  module Querying
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def setting_class(var)
+        "#{var}_settings".camelize
+      end
+
+      def find(*var)
+        if var.size > 1
+          results = where(var: var)
+          raise_record_not_found_exception!(var) if results.blank?
+        else
+          find_by_var!(var.first)
+        end
+      end
+
+      def find_by_var(var)
+        setting = setting_class(var).safe_constantize
+        setting.nil? ? nil : setting.new
+      end
+
+      def find_by_var!(var)
+        setting = find_by_var(var)
+        setting.nil? ? raise_record_not_found_exception!(var) : setting
+      end
+
+      def where(options={})
+        vars = Hash[options][:var]
+        return all if vars.nil?
+
+        classes = Array(vars).map { |var| setting_class(var).safe_constantize }
+        classes.reject(&:nil?).map { |setting| setting.new  }
+      end
+
+      def all
+        if setting_names.empty?
+          files = Dir.glob(Rails.root.join('app', 'settings', '*.rb'))
+          files = files.map { |file| file.to_s.split('/').last.sub('_settings.rb', '') }
+
+          where(var: files)
+        else
+          new.all
+        end
+      end
+
+      def method_missing(method, *args, &block)
+        setting = find_by_var(method)
+        setting.nil? ? super : setting
+      end
+
+      private
+
+        def raise_record_not_found_exception!(ids)
+          vars  = ids.is_a?(Array) ? "(#{ids.join(', ')})" : ids
+          error = "Couldn't find Settings with var: #{vars}"
+
+          raise ActiveRecord::RecordNotFound.new(error, 'Settings', 'var')
+        end
+    end
+  end
+end

data/lib/smart_settings/setting.rb

@@ -0,0 +1,7 @@
+require 'active_record'
+
+module SmartSettings
+  class Setting < ActiveRecord::Base
+    self.table_name = 'settings'
+  end
+end

data/lib/smart_settings/version.rb

@@ -0,0 +1,3 @@
+module SmartSettings
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: smart_settings
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jonian Guveli
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: tableless
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Stores and retrieves settings on an ActiveRecord class, with support
+  for application and per record settings.
+email:
+- jonian@hardpixel.eu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/smart_settings/install_generator.rb
+- lib/generators/smart_settings/setting_generator.rb
+- lib/generators/smart_settings/templates/migration.rb
+- lib/generators/smart_settings/templates/model.rb
+- lib/generators/smart_settings/templates/setting.rb
+- lib/smart_settings.rb
+- lib/smart_settings/attributes.rb
+- lib/smart_settings/base.rb
+- lib/smart_settings/naming.rb
+- lib/smart_settings/persistence.rb
+- lib/smart_settings/querying.rb
+- lib/smart_settings/setting.rb
+- lib/smart_settings/version.rb
+homepage: https://github.com/hardpixel/smart-settings
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Persist application or record settings on ActiveRecord
+test_files: []