iron-settings 1.0.0

data/spec/settings/db_store_spec.rb

@@ -0,0 +1,12 @@
+describe Settings::DBStore do
+  
+  before do
+    @store = Settings::DBStore.new(Settings::Root.new, Settings)
+  end
+  
+  it 'should save values' do
+    @store.set_value('tim', :f00)
+    @store.get_value('tim').should == :f00
+  end
+  
+end

data/spec/settings/db_value_spec.rb

@@ -0,0 +1,58 @@
+describe Settings::DBValue do
+
+  before do
+    TestModel.delete_all
+    Settings::DBValue.delete_all
+  end
+  
+  it 'should save to the DB' do
+    setting =  Settings::DBValue.new(:context => TestModel, :full_key => 'foo', :value => 'bar')
+    setting.save!
+  end
+  
+  it 'should load from the DB' do
+    add_val(TestModel, 'unique', 'bar')
+    setting = Settings::DBValue.find_by_full_key('unique')
+    setting.should_not be_nil
+    setting.value.should == 'bar'
+  end
+
+  it 'should find all owned values via scope' do
+    model = TestModel.create!(:name => 'bobby')
+    add_vals(TestModel, 
+      'alpha' => 'a', 
+      'beta' => 'b'
+    )
+    add_vals(model, 
+      'do' => 'a', 
+      're' => 'b',
+      'mi' => 'c'
+    )
+    vals = Settings::DBValue.for_context(TestModel)
+    vals.count.should == 2
+    vals = Settings::DBValue.for_context(model)
+    vals.count.should == 3
+  end
+  
+  it 'should reload values in the same state as they are saved' do
+    add_vals(TestModel,
+      'string' => 'stringy',
+      'int' => 501,
+      'sym' => :bob
+    )
+    Settings::DBValue.find_by_full_key('string').value.should be_a(String)
+    Settings::DBValue.find_by_full_key('int').value.should be_a(Fixnum)
+    Settings::DBValue.find_by_full_key('sym').value.should be_a(Symbol)
+  end
+  
+  def add_vals(context, val_map)
+    val_map.each_pair do |k, v|
+      add_val(context, k, v)
+    end
+  end
+  
+  def add_val(context, key, val)
+    Settings::DBValue.create!(:context => context, :full_key => key, :value => val)
+  end
+
+end  

data/spec/settings/entry_spec.rb

@@ -0,0 +1,34 @@
+describe Settings::Entry do
+
+  before do
+    @settings = Settings::Root.new
+    Settings::Builder.define(@settings) do 
+      string('astring')
+      int('someint', 25)
+      symbol('procsym') { ('some_' + 'symbol').to_sym }
+    end
+  end
+
+  it 'should know it is an entry' do
+    entry = @settings.find_entry('astring')
+    entry.should be_entry
+    entry.should_not be_group
+  end
+
+  it 'should know its type' do
+    @settings.find_entry('astring').type.should == :string
+  end
+  
+  it 'should return undefined defaults as nil' do
+    @settings.find_entry('astring').default.should be_nil
+  end
+
+  it 'should return simple defaults' do
+    @settings.find_entry('someint').default.should == 25
+  end
+  
+  it 'should save blocks as defaults' do
+    @settings.find_entry('procsym').default.should be_a(Proc)
+  end
+
+end

data/spec/settings/group_spec.rb

@@ -0,0 +1,35 @@
+describe Settings::Group do
+
+  before do
+    @root = Settings::Root.new
+  end
+  
+  it 'should know it is a group' do
+    @root.add_group('sub')
+    group = @root.find_group('sub')
+    group.should be_group
+    group.should_not be_entry
+  end
+
+  it 'should know its full key' do
+    fun = @root.add_group('fun')
+    times = fun.add_group('times')
+    fun.key.should == 'fun'
+    times.key.should == 'fun.times'
+  end
+  
+  it 'should find child groups' do
+    @root.add_group('sub')
+    group = @root.find_group('sub')
+    group.should be_a(Settings::Group)
+    group.key.should == 'sub'
+  end
+  
+  it 'should find child entries' do
+    @root.add_entry('some_value', :string)
+    entry = @root.find_entry('some_value')
+    entry.should be_a(Settings::Entry)
+    entry.key.should == 'some_value'
+  end
+
+end

data/spec/settings/instance_level_spec.rb

@@ -0,0 +1,44 @@
+describe Settings::InstanceLevel do
+
+  before do
+    Settings::DBValue.delete_all
+    @model = TestModel.new(:name => 'test')
+  end
+  
+  it 'should be available in all Objects' do
+    Object.should respond_to(:instance_settings)
+  end
+  
+  it 'should return a Builder instance' do
+    class Bob ; end
+    Bob.instance_settings.should be_a(Settings::Builder)
+  end
+  
+  it 'should not be available at class level' do
+    class Tim
+      instance_settings do
+        int('foo')
+      end
+    end
+    Tim.respond_to?(:settings).should be_false
+  end
+  
+  it 'should allow setting values for a specific model' do
+    @model.settings.some_num.should == 5
+    @model.settings.some_num = 10
+    @model.settings.some_num.should == 10
+  end
+  
+  it 'should save pending settings values to the database when the model is saved' do
+    Settings::DBValue.find_by_full_key('some_num').should be_nil      # Sanity check - not yet in DB
+    @model.settings.some_num = 20
+    Settings::DBValue.find_by_full_key('some_num').should be_nil      # Setting value should not save
+    @model.save
+    Settings::DBValue.find_by_full_key('some_num').should_not be_nil  # Saving model SHOULD
+    
+    # Reset model state and verify settings load correct value
+    @model.settings_reset!
+    @model.settings.some_num.should == 20
+  end
+  
+end

data/spec/settings/settings_spec.rb

@@ -0,0 +1,61 @@
+describe Settings do
+
+  it 'should return the list of installed data types' do
+    Settings.data_types.should =~ [:int, :string, :bool, :symbol, :var]
+  end
+
+  it 'should correctly parse values that are of the right type' do
+    # Valid values
+    {
+      :int => 5,
+      :int => -1,
+      :int => '10',
+      :string => 'foo',
+      :string => '',
+      :string => nil,
+      :symbol => :f123_foo,
+      :bool => true,
+      :bool => false,
+      :bool => nil,
+      :int_list => [5,2,-13,'0'],
+      :string_list => [],
+      :string_list => ['a', 'b'],
+      :var => [1, :a, 'yo'],
+      :var => Time.now
+    }.each_pair do |type, val|
+      expect { Settings.parse(val, type) }.to_not raise_error
+    end
+  end
+
+  it 'should raise an error when parsing invalid values' do
+    # Invalid values
+    {
+      :int => 5.0,
+      :string => :symmish,
+      :string => [],
+      :symbol => 'stringish',
+      :bool => 'true',
+      :bool => 0,
+      :bool => 1,
+      :int_list => [0,:bob],
+      :int_list => 12
+    }.each_pair do |type, val|
+      expect { Settings.parse(val, type) }.to raise_error(ArgumentError)
+    end
+  end
+  
+  it 'should pick a nice settings timestamp file path' do
+    Settings.default_timestamp_file('SimpleTest').should == File.join(Dir.tmpdir, 'simple-test-settings.txt')
+  end
+
+  # Used below...
+  class ClassLevelClass
+    class_settings
+  end
+  
+  it 'should provide a list of classes with class-level settings' do
+    Settings.classes.should be_a(Array)
+    Settings.classes.should include(ClassLevelClass)
+  end
+  
+end

data/spec/settings/static_store_spec.rb

@@ -0,0 +1,46 @@
+describe Settings::StaticStore do
+
+  class StaticStoreTest
+    class_settings do
+      int('val1')
+      string('val2')
+      group('group1') do
+        symbol('val3')
+      end
+    end
+  end
+  
+  before do
+    @store = Settings::StaticStore.new(Settings::Root.new)
+  end
+  
+  it 'should save values' do
+    @store.set_value('foo.bar', 27)
+    @store.get_value('foo.bar').should == 27
+  end
+  
+  it 'should accept paths' do
+    store = Settings::StaticStore.new(StaticStoreTest.settings.root, :file => SpecHelper.sample_path('static-test'))
+    store.paths.count.should == 1
+    store.paths.first.should == SpecHelper.sample_path('static-test')
+  end
+  
+  it 'should need a reload on first init with one or more paths' do
+    store = Settings::StaticStore.new(StaticStoreTest.settings.root, :file => SpecHelper.sample_path('static-test'))
+    store.should be_need_reload
+  end
+  
+  it 'should ignore missing files' do
+    store = Settings::StaticStore.new(StaticStoreTest.settings.root, :file => '/tmp/made-up')
+    store.load
+    store.get_value('val1').should be_nil
+  end
+  
+  it 'should load all paths in order' do
+    store = Settings::StaticStore.new(StaticStoreTest.settings.root, :files => [SpecHelper.sample_path('static-test'), SpecHelper.sample_path('static-test-2')])
+    store.load
+    store.get_value('val1').should == 205
+    store.get_value('val2').should == 'dogbone'
+  end
+  
+end

data/spec/settings/value_store_spec.rb

@@ -0,0 +1,55 @@
+describe Settings::ValueStore do
+  
+  it 'should require_reload? after initialization' do
+    @store = Settings::ValueStore.new(Settings::Root.new)
+    @store.should be_need_reload
+  end
+  
+  it 'should always reload on reload == true' do
+    @store = Settings::ValueStore.new(Settings::Root.new, :reload => true)
+    @store.load
+    @store.should be_need_reload
+  end
+  
+  it 'should never reload on reload == false' do
+    @store = Settings::ValueStore.new(Settings::Root.new, :reload => false)
+    @store.load
+    @store.should_not be_need_reload
+  end
+  
+  it 'should reload after x seconds on reload == x' do
+    @store = Settings::ValueStore.new(Settings::Root.new, :reload => 1)
+    @store.load
+    @store.should_not be_need_reload
+    sleep 1
+    @store.should be_need_reload
+  end
+  
+  it 'should reload on file mtime change on reload == "some path"' do
+    # Set test file path and create/update it
+    path = File.join(Dir.tmpdir, 'settings-test.txt')
+    FileUtils.touch(path)
+
+    # Set our store to reload based on that file
+    @store = Settings::ValueStore.new(Settings::Root.new, :reload => path)
+    @store.load
+    @store.should_not be_need_reload
+    
+    # Sleep a bit (needed due to OSX mtime resolution of 1 second... grr)
+    sleep 1.1
+    FileUtils.touch(path)
+    @store.should be_need_reload
+  end
+  
+  it 'should reload conditionally on reload == { some proc }' do
+    # Set reload to a lambda referencing a locally scoped variable, toggle variable and
+    # ensure need_reload? toggles as well...
+    doit = true
+    @store = Settings::ValueStore.new(Settings::Root.new, :reload => lambda { doit })
+    @store.load
+    @store.should be_need_reload
+    doit = false
+    @store.should_not be_need_reload
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,50 @@
+# Set up activerecord & in-memory SQLite DB
+require 'active_record'
+require 'sqlite3'
+ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
+
+# Uncomment to enable SQL logging during tests for debugging
+# require 'logger'
+# ActiveRecord::Base.logger = Logger.new(STDOUT)
+
+# Require our library
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'iron', 'settings'))
+
+# Run our migration to add DB value models to test DB
+require_relative('../db/settings_migration')
+SettingsMigration.migrate(:up)
+
+# Run migration to create test model to use as settings owner
+ActiveRecord::Migration.create_table :test_models do |t|
+  t.string 'name'
+end
+
+# Create test model class
+class TestModel < ActiveRecord::Base
+  instance_settings do
+    int('some_num', 5)
+    int('no_default')
+    group('some_group') do
+      string('some_string')
+      group('subgrouper') do
+        symbol('yo', :baby)
+      end
+    end
+  end
+end
+
+# Config RSpec options
+RSpec.configure do |config|
+  config.color = true
+  config.add_formatter 'documentation'
+  config.backtrace_clean_patterns = [/rspec/]
+end
+
+module SpecHelper
+  
+  # Helper to find sample file paths
+  def self.sample_path(file)
+    File.expand_path(File.join(File.dirname(__FILE__), 'samples', file))
+  end
+  
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: iron-settings
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Rob Morris
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: iron-extensions
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+description: Allows defining settings with defaults to be overridden in code or via
+  database values.  Built to work well with Rails models.
+email:
+- rob@irongaze.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/iron/rake_loader.rb
+- lib/iron/settings/builder.rb
+- lib/iron/settings/class_level.rb
+- lib/iron/settings/cursor.rb
+- lib/iron/settings/db_store.rb
+- lib/iron/settings/db_value.rb
+- lib/iron/settings/entry.rb
+- lib/iron/settings/group.rb
+- lib/iron/settings/instance_level.rb
+- lib/iron/settings/node.rb
+- lib/iron/settings/root.rb
+- lib/iron/settings/static_store.rb
+- lib/iron/settings/value_store.rb
+- lib/iron/settings.rb
+- lib/tasks/settings.rake
+- db/settings_migration.rb
+- spec/samples/static-test
+- spec/samples/static-test-2
+- spec/settings/builder_spec.rb
+- spec/settings/class_level_spec.rb
+- spec/settings/cursor_spec.rb
+- spec/settings/db_store_spec.rb
+- spec/settings/db_value_spec.rb
+- spec/settings/entry_spec.rb
+- spec/settings/group_spec.rb
+- spec/settings/instance_level_spec.rb
+- spec/settings/settings_spec.rb
+- spec/settings/static_store_spec.rb
+- spec/settings/value_store_spec.rb
+- spec/spec_helper.rb
+- LICENSE
+- History.txt
+- Version.txt
+- README.rdoc
+- .rspec
+homepage: http://irongaze.com
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Application settings in code and database
+test_files: []