clean_settings 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f2df11a01e16f179b2581f8e147f803030fb87f6
+  data.tar.gz: cf07a4ff3d5a28486fb7a93abffe4758e1c1333f
+SHA512:
+  metadata.gz: 348579bc2a5f4ec60ffef36c7d605ca4e55e0d967ef60eafce792115f67dc2c03030f6b8416e83b4379325faa5ff3803a843bee6273a1d68b1bab010a99935d4
+  data.tar.gz: b9ce4977ee7dc642c695ef4e77eb703359c52e8212979d44a622944c0c00ca4de1a244bbc46884ca551d5e9a95e1de7b5d2b8146d97498e09645e6268b58ea85

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/bin/
+.travis.yml
+*.gem

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+gemspec
+
+gem 'rails', '~> 4.2.3'
+
+group :development do
+  gem 'pry', '~> 0.10.1'
+  gem 'pry-byebug', '~> 3.1.0'
+end
+
+group :test do
+  gem 'rspec', '~> 3.3.0'
+  gem 'sqlite3', '~> 1.3.10'
+end

data/README.md

@@ -0,0 +1,131 @@
+# CleanSettings
+
+CleanSettings - it's simple and clean settings for your Rails project.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'clean_settings'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install clean_settings
+```
+
+Run a generator:
+
+```bash
+rails g clean_settings:install
+```
+
+## Usage
+
+After installattion you will have a CleanSettings::Setting active_record model. If you want to extend this model you can use inheritance:
+
+```ruby
+class CleanSettings < CleanSettings::Setting
+```
+
+#### Default settings
+
+If you need default settings for your Rails project you can add ruby file to config/initializers folder. Personally I prefer to name it as **default_settings.rb**. And fill this file with settings that you need:
+```ruby
+CleanSettings.defaults.project_name = "name"
+CleanSettings.defaults.project_key = 123456789
+CleanSettings.defaults.configs = { time: "UTC", currency_code: 980 }
+```
+After restart your project you will be able to get you defaults settings:
+```ruby
+CleanSettings.defaults.project_name # =>  "name"
+CleanSettings.project_name      # =>  "name"
+```
+Get all defaults settings in hash with indifferent access :
+
+```ruby
+CleanSettings.all_defaults  
+```
+
+Clearing default settings.
+
+```ruby
+CleanSettings.clear_defaults
+```
+
+Default settings are not saved to DB. Because they are 'defaults'. That's why when you clear default settings it will clear them only for current session. When your app is restarted, your default settings will be returned according your **default_settings.rb** file.
+
+#### Global settings
+
+For adding and getting settings that will be available anywhere in your project you can write like this:
+```ruby
+# set
+CleanSettings.project_name = "name"
+
+# get
+CleanSettings.project_name  # => "name"
+```
+If you prefer an array notation:
+```ruby
+# set
+CleanSettings[:project_name] = "name"
+
+# get
+CleanSettings[:project_name]  # => "name"
+```
+When you adding a setting with the name that was used for default setting  you override default setting:
+
+```ruby
+CleanSettings.defaults[:name] = "default name"
+CleanSettings.name    # => "default name"
+
+CleanSettings.name = "another name"
+CleanSettings.name  # => "another name"
+```
+
+Get all global settings in hash with indifferent access
+
+```ruby
+CleanSettings.all_globals  
+```
+
+##### Get all settings
+All settings (default and global) you can get through any of these methods:
+
+```ruby
+CleanSettings.all_settings
+# or
+CleanSettings.fetch
+```
+Global settings will be merged with default settings.
+
+#### Ownerable settings
+
+Often you need specific settings for an object. With **CleanSettings** simple add a :has_settings method to you model:
+
+```ruby
+class User < ActiveRecord::Base
+  has_settings
+end
+```
+And use it:
+
+```ruby
+@user = User.new
+@user.settings.subscribe_to_notifications = true
+@user.settings.subscribe_to_notifications # => true
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ashlinchak/clean_settings.
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "clean_settings"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start
+
+# require "irb"
+# IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/clean_settings.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'clean_settings/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "clean_settings"
+  spec.version       = CleanSettings::VERSION
+  spec.authors       = ["Alexander Shlinchak"]
+  spec.email         = ["ashlinchak@gmail.com"]
+
+  spec.summary       = %q{Simple and clean settings for your Rails project.}
+  spec.description   = %q{Storing global and object's settings in DB. Simple for using in Rails applicatons.}
+  spec.homepage      = "https://github.com/ashlinchak/clean_settings"
+
+  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.add_dependency("rails", [">= 4.0.0"])
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.3.0"
+  spec.add_development_dependency "sqlite3", "~> 1.3.10"
+end

data/lib/clean_settings/has_settings.rb

@@ -0,0 +1,18 @@
+module CleanSettings
+  module HasSettings
+    def has_settings
+      send :include, HasSettings::InstanceMethods
+
+      scope :with_setting, -> (var) {
+        joins("JOIN clean_settings ON (clean_settings.owner_id = #{self.table_name}.#{self.primary_key} AND
+         clean_settings.owner_type = '#{self.base_class.name}') AND clean_settings.var = '#{var}'")
+      }
+    end
+
+    module InstanceMethods
+      def settings
+        CleanSettings::Ownerable.for_thing(self)
+      end
+    end
+  end
+end

data/lib/clean_settings/ownerable.rb

@@ -0,0 +1,12 @@
+module CleanSettings
+  class Ownerable < Setting
+    def self.for_thing(object)
+      @object = object
+      self
+    end
+
+    def self.with_owner
+      unscoped.where(owner_type: @object.class.base_class.to_s, owner_id: @object.id)
+    end
+  end
+end

data/lib/clean_settings/setting.rb

@@ -0,0 +1,110 @@
+module CleanSettings
+  class Setting < ActiveRecord::Base
+    self.table_name = "clean_settings"
+
+    class SettingNotFound < RuntimeError; end
+
+    @@defaults = OpenStruct.new
+
+    def value
+      YAML::load(self[:value])
+    end
+
+    def value=(new_value)
+      self[:value] = new_value.to_yaml
+    end
+
+    class << self
+      def defaults
+        @@defaults ||= OpenStruct.new
+      end
+
+      def fetch_defaults
+        @@defaults.to_h.with_indifferent_access
+      end
+      alias_method :all_defaults, :fetch_defaults
+
+      def defaults=(key, value)
+        @@defaults[:key] = value
+      end
+
+      def clear_defaults
+        @@defaults = OpenStruct.new
+      end
+
+      def [](var_name)
+        if var = object(var_name)
+          var.value
+        elsif @@defaults[var_name.to_s]
+          @@defaults[var_name.to_s]
+        else
+          nil
+        end
+      end
+
+      def []=(var_name, value)
+        var_name = var_name.to_s
+
+        record = object(var_name) || with_owner.new(var: var_name)
+        record.value = value
+        record.save!
+
+        value
+      end
+
+      def destroy(var_name)
+        var_name = var_name.to_s
+        
+        if obj = object(var_name)
+          obj.destroy
+          true
+        else
+          raise SettingNotFound, "Setting variable \"#{var_name}\" not found"
+        end
+      end
+
+      def fetch_globals
+        vars = with_owner.select(:var, :value)
+
+        result = {}
+        vars.each { |record| result[record.var] = record.value }
+        result.with_indifferent_access
+      end
+      alias_method :all_globals, :fetch_globals
+
+      def fetch
+        fetch_defaults.merge(fetch_globals)
+      end
+      alias_method :all_settings, :fetch
+
+
+      def for_thing(owner)
+        @owner = owner
+        self
+      end
+
+      def with_owner
+        unscoped.where("owner_type is NULL and owner_id is NULL")
+      end
+
+      def object(var_name)
+        with_owner.find_by(var: var_name)
+      end
+
+      def method_missing(method, *args, &block)
+        method_name = method.to_s
+        super(method, *args, &block)
+
+      rescue NoMethodError
+
+        if method_name[-1] == "="
+          var_name = method_name.chop
+          value = args[0]
+          self[var_name] = value
+        else
+          self[method_name]
+        end
+      end
+    end
+  end
+end

data/lib/clean_settings/version.rb

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

data/lib/clean_settings.rb

@@ -0,0 +1,9 @@
+require 'ostruct'
+require "clean_settings/version"
+require "clean_settings/setting"
+require "clean_settings/ownerable"
+require "clean_settings/has_settings"
+
+module CleanSettings
+  ActiveRecord::Base.extend CleanSettings::HasSettings
+end

data/lib/generators/clean_settings/install_generator.rb

@@ -0,0 +1,14 @@
+require 'rails/generators/migration'
+
+class CleanSettings::InstallGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+  source_root File.expand_path('../templates', __FILE__)
+
+  def self.next_migration_number(path)
+    Time.now.utc.strftime("%Y%m%d%H%M%S")
+  end
+
+  def generate_files
+    migration_template 'migration.rb', 'db/migrate/create_clean_settings_table.rb'
+  end
+end

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

@@ -0,0 +1,18 @@
+class CreateConfirmedAttributesTables < ActiveRecord::Migration
+  def self.up
+    create_table :clean_settings do |t|
+      t.string :var, null: false
+      t.text :value, null: false
+      t.integer :owner_id,   null: true
+      t.string  :owner_type, null: true, limit: 30
+
+      t.timestamps
+    end
+
+    add_index :clean_settings, [:owner_type, :owner_id, :var], unique: true
+  end
+
+  def self.down
+    drop_table :clean_settings
+  end
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: clean_settings
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alexander Shlinchak
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.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: 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: 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: Storing global and object's settings in DB. Simple for using in Rails
+  applicatons.
+email:
+- ashlinchak@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- clean_settings.gemspec
+- lib/clean_settings.rb
+- lib/clean_settings/has_settings.rb
+- lib/clean_settings/ownerable.rb
+- lib/clean_settings/setting.rb
+- lib/clean_settings/version.rb
+- lib/generators/clean_settings/install_generator.rb
+- lib/generators/clean_settings/templates/migration.rb
+homepage: https://github.com/ashlinchak/clean_settings
+licenses: []
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Simple and clean settings for your Rails project.
+test_files: []
+has_rdoc: