rsettings 0.2.0 → 0.3.0

data/.rsettings

@@ -0,0 +1,2 @@
+---
+:ben_rules: 'yes'

data/README.md

@@ -1,4 +1,6 @@
-settings
+RSettings
 ========
 
+[![Build Status](https://secure.travis-ci.org/ben-biddington/rsettings.png)](http://travis-ci.org/ben-biddington/rsettings)
+
 Settings for ruby programs

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/lib/rsettings/adapters/basic_disk_settings.rb

@@ -0,0 +1,51 @@
+class BasicDiskSettings
+  require "fileutils"; include FileUtils
+  require "audible"; include Audible
+  require "yaml"
+
+  def initialize(&block)
+    @file = ".rsettings"
+    _ensure
+    instance_eval &block if block_given?
+  end
+
+  def clear
+    rm file if exists?
+  end
+
+  def set(opts ={})
+    opts = all.merge opts
+
+    File.open file, "w+" do |io|
+      io.puts opts.to_yaml
+    end 
+
+    notify :set, @settings
+  end
+
+  def get(name)
+    settings[name].tap{|result| notify_missing name unless result}
+  end
+
+  def file; @file; end
+
+  private
+
+  def settings; @settings ||= all; end
+
+  def all
+    return {} unless exists?
+
+    YAML.load(IO.read(file))
+  end
+
+  def notify_missing(name)
+    notify :missing, name
+  end
+
+  def exists?; File.exists? file; end
+
+  def _ensure
+    touch file
+  end
+end

data/lib/rsettings/adapters/environment_settings.rb

@@ -1,12 +1,7 @@
 class EnvironmentSettings
   require "audible"; include Audible;
-
-  def initialize
-    @vars = VariableList.new
-  end
   
   def get(name)
-    real_name = @vars.name name
     ENV[name.to_s].tap{|it| notify_missing(name) if it.nil?}
   end
 
@@ -16,9 +11,3 @@ class EnvironmentSettings
     notify :missing, name
   end
 end
-
-class VariableList
-  def name(from)
-    from
-  end
-end

data/lib/rsettings/internal/rsettings.rb

@@ -0,0 +1,29 @@
+class RSettings
+  def initialize(settings, config)
+    @settings,@config = settings,config
+    
+    @settings.on :missing do |e,args|
+      @config.missing.on_missing args.first
+    end
+  end
+
+  def find(m)
+    query = m.to_s.end_with? "?"
+
+    m = m.to_s.delete "?" if query
+
+    setting_name = @config.name_for(m)
+    
+    if query
+      setting_name = @config.name_for(m)
+
+      value = Setting.new @settings.get(setting_name)
+      
+      fail "Unable to convert setting <#{setting_name}> to flag" unless value.truthy?
+      
+      return value.to_s.downcase === "yes"
+    end
+
+    @settings.get(setting_name)    
+  end
+end

data/lib/rsettings/internal/setting.rb

@@ -0,0 +1,10 @@
+class Setting
+  def truthy?; @truthy; end
+  
+  def initialize(text)
+    @text = text.to_s
+    @truthy = text.downcase.match /(yes|no)/
+  end
+
+  def to_s; @text; end
+end

data/lib/rsettings/internal/settings_chain.rb

@@ -0,0 +1,22 @@
+class SettingsChain
+  require "audible"; include Audible
+
+  def initialize(*links)
+    @settings = *links.flatten.map{|klass| klass.new}
+  end
+
+  def get(name)
+    @settings.each do |setting|
+      result = setting.get(name)
+      return result if result
+    end
+    
+    notify_missing name
+  end
+
+  private
+
+  def notify_missing(name)
+    notify :missing, name
+  end
+end 

data/lib/rsettings/{settings_configuration.rb → internal/settings_configuration.rb}

@@ -1,8 +1,9 @@
 class SettingsConfiguration
-  attr_reader :missing
+  attr_reader :missing, :settings
 
   def initialize
     @missing = FailOnMissing.new
+    @settings = EnvironmentSettings.new
   end
 
   def let(opts = {})
@@ -17,6 +18,14 @@ class SettingsConfiguration
     _opts[setting] || setting
   end
 
+  def with_settings(opts={})
+    if opts.is_a? Hash
+      @settings = SettingsChain.new(opts[:chain]) if opts[:chain]
+    else
+      @settings = opts.new
+    end
+  end
+
   private
 
   def _opts; @opts ||= {}; end

data/lib/rsettings.rb

@@ -4,7 +4,6 @@ Dir.glob(File.join(dir, "rsettings", "**", "*.rb")).each {|f| require f}
 
 class Settings
   def initialize(&block)
-    @settings = EnvironmentSettings.new
     @config = SettingsConfiguration.new
 
     if block_given?
@@ -13,16 +12,14 @@ class Settings
       end
     end
 
-    @settings.on :missing do |e,args|
-      @config.missing.on_missing args.first
-    end
+    @settings = @config.settings
+
+    fail "Error" unless @config.settings
   end
 
   def method_missing(m, *args, &block)
     fail "Only support queries, cannot do <#{m}>" unless args.empty?
 
-    setting_name = @config.name_for m
-    
-    @settings.get(setting_name)
+    RSettings.new(@settings, @config).find m
   end
 end

data/rsettings.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "rsettings"
-  s.version = "0.2.0"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ben Biddington"]
-  s.date = "2013-12-10"
+  s.date = "2013-12-11"
   s.description = "Settings"
   s.email = "ben.biddington@gmail.com"
   s.extra_rdoc_files = [
@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
   ]
   s.files = [
     ".document",
+    ".rsettings",
     ".travis.yml",
     "Gemfile",
     "Gemfile.lock",
@@ -28,11 +29,18 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "lib/rsettings.rb",
+    "lib/rsettings/adapters/basic_disk_settings.rb",
     "lib/rsettings/adapters/environment_settings.rb",
-    "lib/rsettings/settings_configuration.rb",
+    "lib/rsettings/internal/rsettings.rb",
+    "lib/rsettings/internal/setting.rb",
+    "lib/rsettings/internal/settings_chain.rb",
+    "lib/rsettings/internal/settings_configuration.rb",
     "rsettings.gemspec",
     "settings.gemspec",
+    "spec/integration.tests/adapters/basic_disk_settings_spec.rb",
     "spec/spec_helper.rb",
+    "spec/system.tests/can_fall_back_to_file_settings_spec.rb",
+    "spec/system.tests/can_specify_flags_spec.rb",
     "spec/system.tests/can_use_env_spec.rb",
     "spec/system.tests/options_spec.rb"
   ]

data/spec/integration.tests/adapters/basic_disk_settings_spec.rb

@@ -0,0 +1,43 @@
+require "spec_helper"
+
+describe BasicDiskSettings do
+  let(:settings) {BasicDiskSettings.new}
+
+  before do
+    settings.clear
+  end
+
+  it "can store single setting" do
+    settings.set :name => "value"
+
+    expect(settings.get(:name)).to eql "value"
+  end
+
+  it "can store multiple settings at once" do
+    settings.set :a => "value a", :b => "value b"
+
+    expect(settings.get(:a)).to eql "value a"
+    expect(settings.get(:b)).to eql "value b"
+  end
+
+  it "overwrites duplicates" do
+    settings.set :a => "value a"
+    settings.set :a => "another value for a"
+
+    expect(settings.get(:a)).to eql "another value for a"
+  end
+  
+  it "overwrites duplicates even when setting the same setting" do
+    settings.set :a => "value a", :a => "another value for a"
+
+    expect(settings.get(:a)).to eql "another value for a"
+  end
+
+  it "records all settings when you call set multiple times" do
+    settings.set :a => "value a"
+    settings.set :b => "value b"
+
+    expect(settings.get(:a)).to_not be_nil
+    expect(settings.get(:b)).to_not be_nil
+  end
+end

data/spec/system.tests/can_fall_back_to_file_settings_spec.rb

@@ -0,0 +1,56 @@
+require "spec_helper"
+
+describe "a settings fallback" do
+  before do
+    ENV.clear
+
+    @disk_settings = BasicDiskSettings.new do
+      clear
+      set :jazzs_bike_shorts => "tight"
+    end
+  end
+
+  let (:settings) do 
+    Settings.new do
+      with_settings :chain => [EnvironmentSettings, BasicDiskSettings]
+    end
+  end
+
+  let (:disk_settings) do
+    @disk_settings
+  end
+
+  it "for example, you can fall back to a setting on disk" do
+    expect(settings.jazzs_bike_shorts).to eql "tight"
+  end
+
+  it "you get the environment setting when it exists" do
+    ENV["jazzs_bike_shorts"] = "this is from the environment variables"
+
+    expect(settings.jazzs_bike_shorts).to eql "this is from the environment variables"
+  end
+
+  it "you can fallback one and not another" do
+    ENV["b"] = "env b"
+
+    disk_settings.clear
+    disk_settings.set :a => "disk a", :b => "disk b"
+
+    expect(settings.a).to eql "disk a"
+    expect(settings.b).to eql "env b"
+  end
+
+  it "you can use ONLY disk if you like" do
+    settings = Settings.new do
+      with_settings BasicDiskSettings
+    end
+
+    ENV["ben_rules"] = "expect this to be ignored"
+
+    disk_settings.clear
+    disk_settings.on(:set){|e,args| puts args.first}
+    disk_settings.set :ben_rules => "yes"
+
+    expect(settings.ben_rules).to eql "yes"
+  end
+end

data/spec/system.tests/can_specify_flags_spec.rb

@@ -0,0 +1,31 @@
+require "spec_helper"
+
+describe "settings that are either true or false" do
+  let(:settings){Settings.new}
+
+  before { ENV.clear }
+
+  it "returns a flag when value is 'yes' or 'no'" do
+    ENV["allowed"] = "yes"
+    ENV["disallowed"] = "no"
+
+    expect(settings.allowed?).to be_true
+    expect(settings.disallowed?).to be_false
+  end
+
+  it "any other value returns setting not found" do
+    ENV["allowed"] = "xxx"
+
+    expect{settings.allowed?}.to raise_error /Unable to convert setting <allowed> to flag/
+  end
+
+  it "accepts mapped setting names, too" do
+    settings = Settings.new do
+      let "V" => "verbose"
+    end
+
+    ENV["V"] = "yes"
+
+    expect(settings.verbose?).to be_true
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rsettings
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-10 00:00:00.000000000 Z
+date: 2013-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: audible
@@ -101,6 +101,7 @@ extra_rdoc_files:
 - README.rdoc
 files:
 - .document
+- .rsettings
 - .travis.yml
 - Gemfile
 - Gemfile.lock
@@ -110,11 +111,18 @@ files:
 - Rakefile
 - VERSION
 - lib/rsettings.rb
+- lib/rsettings/adapters/basic_disk_settings.rb
 - lib/rsettings/adapters/environment_settings.rb
-- lib/rsettings/settings_configuration.rb
+- lib/rsettings/internal/rsettings.rb
+- lib/rsettings/internal/setting.rb
+- lib/rsettings/internal/settings_chain.rb
+- lib/rsettings/internal/settings_configuration.rb
 - rsettings.gemspec
 - settings.gemspec
+- spec/integration.tests/adapters/basic_disk_settings_spec.rb
 - spec/spec_helper.rb
+- spec/system.tests/can_fall_back_to_file_settings_spec.rb
+- spec/system.tests/can_specify_flags_spec.rb
 - spec/system.tests/can_use_env_spec.rb
 - spec/system.tests/options_spec.rb
 homepage: http://github.com/ben-biddington/rsettings
@@ -132,7 +140,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 106447213
+      hash: -382109293
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: