setler 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rvmrc

@@ -0,0 +1 @@
+rvm 1.9.2@setler

data/Gemfile

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

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Chris Kelly <ckdake@ckdake.com>
+
+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.rdoc

@@ -0,0 +1,61 @@
+= Setler
+
+Setler is a Gem that lets one easily implement the "Feature Flags" pattern, or add settings to individual models. This is a cleanroom implementation of what the 'rails-settings' gem does. It's been forked all over the place, and my favorite version of it doesn't have any tests and doesn't work with settings associated with models.
+
+== Setup
+
+Install the gem by adding this to your Gemfile:
+
+  gem "setler", git: "git://github.com/ckdake/setler.git"
+  
+Generate the model:
+
+  rails g setler <model_name>
+  
+Run the migration:
+
+  rake db:migrate
+  
+== Usage
+
+Create/Update settings:
+
+  Featureflags.bacon_dispenser_enabled = true
+  Settings.allowed_meats = ['bacon', 'crunchy bacon']
+  
+Read settings:
+
+  Featureflags.bacon_dispenser_enabled # true
+  Settings.allowed_meats.include?('bacon')  # true
+  
+Destroy them:
+
+  Featureflags.destroy :bacon_dispenser_enabled
+  Settings.destroy :allowed_meats
+  
+List all:
+
+  Featureflags.all
+  Settings.all
+  
+Set defaults in an initializer with something like:
+
+  Featureflags.defaults[:bacon_dispenser_enabled] = false
+  Settings.defaults[:allowed_meats] = ['itsnotbacon']
+  
+COING SOON! Add them to any ActiveRecord object:
+
+  class User < ActiveRecord::Base
+    has_setler as: :settings
+  end
+  
+Then you get:
+  
+  user = User.first
+  user.settings.favorite_meat = :bacon
+  user.settings.favorite_meat  # :bacon
+  user.settings.all # { "favorite_meat" => :bacon }
+  
+And look em up:
+
+  User.with_settings_for('favorite_meat') # => scope of users with the favorite_meat setting

data/Rakefile

@@ -0,0 +1,9 @@
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+task default: [:test]

data/lib/generators/setler/setler_generator.rb

@@ -0,0 +1,29 @@
+require 'rails/generators/migration'
+
+class SetlerGenerator < Rails::Generators::NamedBase
+  include Rails::Generators::Migration
+  
+  argument :name, type: :string, default: "settings"
+  
+  source_root File.expand_path('../templates', __FILE__)
+  
+  @@migrations = false
+  
+  def self.next_migration_number(dirname)
+    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
+      "%.3d" % (current_migration_number(dirname) + 1)
+    end
+  end
+  
+  def generate_model
+    template "model.rb", File.join("app/models",class_path,"#{file_name}.rb"), force: true
+    migration_template "migration.rb", "db/migrate/setler_create_#{table_name}.rb"
+  end
+end

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

@@ -0,0 +1,17 @@
+class SetlerCreate<%= table_name.camelize %> < ActiveRecord::Migration
+  def self.up
+    create_table(:<%= table_name %>) do |t|
+      t.string  :var, null: false
+      t.text    :value, null: true
+      t.integer :thing_id, null: true
+      t.string  :thing_type, limit: 30, null: true
+      t.timestamps
+    end
+    
+    add_index :<%= table_name %>, [ :thing_type, :thing_id, :var ], unique: true
+  end
+
+  def self.down
+    drop_table :<%= table_name %>
+  end
+end

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

@@ -0,0 +1,3 @@
+class <%= class_name %> < Setler::Settings
+  
+end

data/lib/setler.rb

@@ -0,0 +1,39 @@
+require File.join(File.dirname(__FILE__), 'setler', 'version')
+require 'pp'
+
+module Setler
+  class Settings < ActiveRecord::Base
+    serialize :value
+    self.abstract_class = true
+    
+    cattr_accessor :defaults
+    @@defaults = {}.with_indifferent_access
+    
+    # Get and Set variables when the calling method is the variable name
+    def self.method_missing(method, *args)
+      method_name = method.to_s
+      super(method, *args)
+      
+    rescue NoMethodError
+      if method_name =~ /=$/
+        self.find_or_create_by_var(method_name.gsub('=', '')).update_attribute(:value, args.first)
+      else
+        self.find_by_var(method_name).try(:value) || @@defaults[method_name]
+      end
+    end
+    
+    def self.destroy(var_name)
+      var_name = var_name.to_s
+      if setting = self.find_by_var(var_name)
+        setting.destroy
+        true
+      else
+        raise SettingNotFound, "Setting variable \"#{var_name}\" not found"
+      end
+    end
+    
+    def self.all
+      Hash[super.collect{ |s| [s.var, s.value] }].merge(@@defaults)
+    end
+  end
+end

data/lib/setler/version.rb

@@ -0,0 +1,3 @@
+module Setler
+  VERSION = "0.0.1"
+end

data/setler.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "setler/version"
+
+Gem::Specification.new do |s|
+  s.name        = "setler"
+  s.version     = Setler::VERSION
+  s.authors     = ["Chris Kelly"]
+  s.email       = ["ckdake@ckdake.com"]
+  s.homepage    = ""
+  s.summary     = %q{Settler lets you use the 'Feature Flags' pettern or add settings to models.}
+  s.description = %q{Setler is a Gem that lets one easily implement the "Feature Flags" pattern, or add settings to individual models. This is a cleanroom implementation of what the 'rails-settings' gem does. It's been forked all over the place, and my favorite version of it doesn't have any tests and doesn't work with settings associated with models.}
+
+  s.rubyforge_project = "setler"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.add_development_dependency('sqlite3')
+  s.add_development_dependency('activerecord')
+  s.add_development_dependency('rake')
+end

data/test/settings_test.rb

@@ -0,0 +1,66 @@
+require 'test_helper'
+
+class Setler::SettingsTest < Test::Unit::TestCase
+  setup_db
+  
+  def setup
+    Setler::Settings.create(:var => 'test',  :value => 'foo')
+    Setler::Settings.create(:var => 'test2', :value => 'bar')
+  end
+  
+  def teardown
+    Setler::Settings.delete_all
+  end
+  
+  def test_defaults
+    Setler::Settings.defaults[:foo] = 'default foo'
+    
+    assert_equal 'default foo', Setler::Settings.foo
+    
+    Setler::Settings.foo = 'bar'
+    assert_equal 'bar', Setler::Settings.foo
+  end
+  
+  def tests_defaults_false
+    Setler::Settings.defaults[:foo] = false
+    assert_equal false, Setler::Settings.foo
+  end
+  
+  def test_get
+    assert_equal 'foo', Setler::Settings.test
+    assert_equal 'bar', Setler::Settings.test2
+  end
+
+  def test_update
+    Setler::Settings.test = '321'
+    assert_equal '321', Setler::Settings.test
+  end
+  
+  def test_create
+    Setler::Settings.onetwothree = '123'
+    assert_equal '123', Setler::Settings.onetwothree
+  end
+  
+  def test_complex_serialization
+    complex = [1, '2', {:three => true}]
+    Setler::Settings.complex = complex
+    assert_equal complex, Setler::Settings.complex
+  end
+
+  def test_serialization_of_float
+    Setler::Settings.float = 0.01
+    Setler::Settings.reload
+    assert_equal 0.01, Setler::Settings.float
+    assert_equal 0.02, Setler::Settings.float * 2
+  end
+  
+  def test_all
+    assert_equal({ "test2" => "bar", "test" => "foo" }, Setler::Settings.all)
+  end
+  
+  def test_destroy
+    assert_not_nil Setler::Settings.test
+    Setler::Settings.destroy :test
+    assert_nil Setler::Settings.test
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,38 @@
+require 'rubygems'
+
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'active_record'
+require 'test/unit'
+
+require File.join(File.dirname(__FILE__), '..', 'lib', 'setler.rb')
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+
+# class User < ActiveRecord::Base
+#   has_settings
+# end
+
+def setup_db
+  ActiveRecord::Schema.define(:version => 1) do
+    create_table :settings do |t|
+      t.string :var, :null => false
+      t.text   :value, :null => true
+      t.integer :target_id, :null => true
+      t.string :target_type, :limit => 30, :null => true
+      t.timestamps
+    end
+    add_index :settings, [ :target_type, :target_id, :var ], :unique => true
+    
+    # create_table :users do |t|
+    #   t.string :name
+    # end
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: setler
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Chris Kelly
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-08-05 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &70360670678960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70360670678960
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &70360670678540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70360670678540
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70360670678120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70360670678120
+description: Setler is a Gem that lets one easily implement the "Feature Flags" pattern,
+  or add settings to individual models. This is a cleanroom implementation of what
+  the 'rails-settings' gem does. It's been forked all over the place, and my favorite
+  version of it doesn't have any tests and doesn't work with settings associated with
+  models.
+email:
+- ckdake@ckdake.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- lib/generators/setler/setler_generator.rb
+- lib/generators/setler/templates/migration.rb
+- lib/generators/setler/templates/model.rb
+- lib/setler.rb
+- lib/setler/version.rb
+- setler.gemspec
+- test/settings_test.rb
+- test/test_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: setler
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: Settler lets you use the 'Feature Flags' pettern or add settings to models.
+test_files:
+- test/settings_test.rb
+- test/test_helper.rb