redis-settings 0.1.0

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,63 @@
+PATH
+  remote: .
+  specs:
+    redis-settings (0.1.0)
+      redis
+      yajl-ruby
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.0.1)
+      activesupport (= 3.0.1)
+      builder (~> 2.1.2)
+      i18n (~> 0.4.1)
+    activerecord (3.0.1)
+      activemodel (= 3.0.1)
+      activesupport (= 3.0.1)
+      arel (~> 1.0.0)
+      tzinfo (~> 0.3.23)
+    activesupport (3.0.1)
+    archive-tar-minitar (0.5.2)
+    arel (1.0.1)
+      activesupport (~> 3.0.0)
+    builder (2.1.2)
+    columnize (0.3.2)
+    diff-lcs (1.1.2)
+    i18n (0.4.2)
+    linecache19 (0.5.11)
+      ruby_core_source (>= 0.1.4)
+    redis (2.1.1)
+    rspec (2.1.0)
+      rspec-core (~> 2.1.0)
+      rspec-expectations (~> 2.1.0)
+      rspec-mocks (~> 2.1.0)
+    rspec-core (2.1.0)
+    rspec-expectations (2.1.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.1.0)
+    ruby-debug-base19 (0.11.24)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby_core_source (>= 0.1.4)
+    ruby-debug19 (0.11.6)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby-debug-base19 (>= 0.11.19)
+    ruby_core_source (0.1.4)
+      archive-tar-minitar (>= 0.5.2)
+    sqlite3-ruby (1.3.2)
+    tzinfo (0.3.23)
+    yajl-ruby (0.7.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord
+  redis
+  redis-settings!
+  rspec (>= 2.0.0)
+  ruby-debug19
+  sqlite3-ruby
+  yajl-ruby

data/README.rdoc

@@ -0,0 +1,75 @@
+= Redis::Settings
+
+Store application and user settings on Redis. Comes with ActiveRecord support.
+
+== Installation
+
+  gem install redis-settings
+
+Redis::Settings store all data in JSON format. The default parser is yajl-ruby[https://rubygems.org/gems/yajl-ruby], with fallback to json[https://rubygems.org/gems/json]. Make sure you have one of those installed.
+
+== Usage
+
+  require "redis/settings"
+
+  # Reuse an existing Redis connection.
+  Redis::Settings.configure do |config|
+    config.connection = Redis.new(:host => "localhost", :port => 6379)
+  end
+
+  # Create settings namespaced to app
+  settings = Redis::Settings.new("app")
+  settings.namespace
+  #=> "settings/app"
+
+  # Set values
+  settings[:items_per_page] = 10
+  settings.set(:items_per_page, 10)
+
+  # Get values
+  settings[:items_per_page]
+  settings.get(:items_per_page)
+  settings.get(:items_per_page, 20) #=> return 20 when items_per_page is not defined
+
+  # Remove all settings on this namespace
+  settings.clear
+
+  # Retrieve a hash with defined settings
+  settings.all
+
+=== ActiveRecord
+
+  class User < ActiveRecord::Base
+  end
+
+  user = User.first
+  user.settings[:role] = "admin"
+
+<b>NOTE:</b> When record is destroyed, all settings are erased.
+
+= Mantainer
+
+* Nando Vieira (http://nandovieira.com.br)
+
+= License
+
+(The MIT License)
+
+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/Rakefile

@@ -0,0 +1,5 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new

data/lib/redis/settings/active_record.rb

@@ -0,0 +1,25 @@
+class Redis
+  class Settings
+    module ActiveRecord
+      def self.included(base)
+        base.class_eval do
+          include InstanceMethods
+          after_destroy :clear_settings
+        end
+      end
+
+      module InstanceMethods
+        def settings
+          raise Redis::Settings::NewRecordError if new_record?
+          @settings ||= Settings.new("#{self.class.name.underscore}/#{id}")
+        end
+
+        def clear_settings
+          settings.clear
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, Redis::Settings::ActiveRecord

data/lib/redis/settings/version.rb

@@ -0,0 +1,10 @@
+class Redis
+  class Settings
+    module Version
+      MAJOR = 0
+      MINOR = 1
+      PATCH = 0
+      STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
+    end
+  end
+end

data/lib/redis/settings.rb

@@ -0,0 +1,100 @@
+require "redis"
+
+begin
+  require "yajl/json_gem"
+rescue LoadError
+  require "json"
+end
+
+class Redis
+  class Settings
+    require "redis/settings/active_record" if defined?(ActiveRecord)
+
+    class NewRecordError < StandardError
+      def message
+        "You can't access settings on new records"
+      end
+    end
+
+    class << self
+      attr_accessor :connection
+    end
+
+    # Return Redis::Settings.
+    #
+    #   Redis::Settings.configure do |config|
+    #     config.connection = Redis.new(:host => "localhost", :port => 6379)
+    #   end
+    #
+    def self.configure(&block)
+      yield self
+    end
+
+    # Initialize a new object that will be wrapped into the specified
+    # namespace.
+    #
+    #   s = Redis::Settings.new("app")
+    #
+    def initialize(namespace)
+      @namespace = namespace
+    end
+
+    # Returned namespace with <tt>settings</tt> as its root.
+    #
+    #   s = Redis::Settings.new("app")
+    #   s.namespace
+    #   #=> "settings/app"
+    #
+    def namespace
+      "settings/#{@namespace}"
+    end
+
+    # Retrieve setting by its name. When nil, return the default value.
+    #
+    #   s = Redis::Settings.new("app")
+    #   s.get(:items_per_page)
+    #   s.get(:items_per_page, 10)
+    #
+    def get(name, default = nil)
+      value = redis.hget(namespace, name)
+
+      if value
+        payload = JSON.parse(value)
+        value = payload["data"]
+      end
+
+      value || default
+    end
+
+    # Define a value for the specified setting.
+    #
+    #   s = Redis::Settings.new("app")
+    #   s.set(:items_per_page, 10)
+    #
+    def set(name, value)
+      if value.nil?
+        redis.hdel(namespace, name)
+      else
+        redis.hset(namespace, name, {:data => value}.to_json)
+      end
+    end
+
+    # Remove all settings from the current namespace
+    def clear
+      redis.del(namespace)
+    end
+
+    # Return a hash with all settings
+    def all
+      Hash[redis.hgetall(namespace).collect {|k, v| [k.to_sym, JSON.parse(v)["data"]]}]
+    end
+
+    alias_method :[]=, :set
+    alias_method :[], :get
+
+    private
+    def redis # :nodoc:
+      self.class.connection
+    end
+  end
+end

data/lib/redis-settings.rb

@@ -0,0 +1 @@
+require "redis/settings"

data/redis-settings.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "redis/settings/version"
+
+Gem::Specification.new do |s|
+  s.name        = "redis-settings"
+  s.version     = Redis::Settings::Version::STRING
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Nando Vieira"]
+  s.email       = ["fnando.vieira@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %[Store application and user settings on Redis. Comes with ActiveRecord support.]
+  s.description = s.summary
+
+  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_dependency "redis"
+  s.add_development_dependency "rspec", ">= 2.0.0"
+  s.add_development_dependency "ruby-debug19"
+  s.add_development_dependency "activerecord"
+  s.add_development_dependency "sqlite3-ruby"
+end

data/spec/redis/settings/active_record_spec.rb

@@ -0,0 +1,40 @@
+require "spec_helper"
+
+describe Redis::Settings::ActiveRecord do
+  let(:user) { User.create }
+  let(:admin) { Admin::User.create }
+
+  before do
+    user.settings.clear
+    admin.settings.clear
+  end
+
+  it "should inject settings method" do
+    User.new.should respond_to(:settings)
+  end
+
+  it "should raise when trying to access settings from a new record" do
+    expect {
+      User.new.settings
+    }.to raise_error(Redis::Settings::NewRecordError)
+  end
+
+  it "should set namespace accordingly" do
+    user.settings.namespace.should == "settings/user/#{user.id}"
+    admin.settings.namespace.should == "settings/admin/user/#{admin.id}"
+  end
+
+  it "should define setting" do
+    admin.settings[:role] = "admin"
+    user.settings[:role] = "support"
+
+    user.settings[:role].should == "support"
+    admin.settings[:role].should == "admin"
+  end
+
+  it "should remove all settings when destroy a record" do
+    user.settings[:role] = "customer"
+    user.destroy
+    Redis::Settings.connection.hgetall("settings/user/#{user.id}").should be_empty
+  end
+end

data/spec/redis/settings_spec.rb

@@ -0,0 +1,76 @@
+require "spec_helper"
+
+describe Redis::Settings do
+  subject { Redis::Settings.new("app") }
+  let(:redis) { Redis::Settings.connection }
+
+  before do
+    subject.clear
+  end
+
+  describe ".all" do
+    it "should return all settings" do
+      subject[:items] = 10
+      subject[:enabled] = true
+
+      subject.all.should == {:items => 10, :enabled => true}
+    end
+  end
+
+  describe ".configure" do
+    it "should yield module" do
+      Redis::Settings.configure {|config| config.should be(Redis::Settings)}
+    end
+  end
+
+  describe ".namespace" do
+    it "should include settings as namespace root" do
+      subject.namespace.should == "settings/app"
+    end
+  end
+
+  describe ".set" do
+    it "should set value" do
+      subject.set(:items, 5)
+      JSON.parse(redis.hget(subject.namespace, :items)).should == {"data" => 5}
+    end
+
+    it "should have shortcut" do
+      subject[:items] = 10
+      JSON.parse(redis.hget(subject.namespace, :items)).should == {"data" => 10}
+    end
+
+    it "should remove setting when assigning nil" do
+      subject[:items] = 20
+      subject[:items] = nil
+      redis.hget(subject.namespace, :items).should be_nil
+    end
+  end
+
+  describe ".get" do
+    it "should get value" do
+      subject.set(:items, 5)
+      subject.get(:items).should == 5
+    end
+
+    it "should have alias" do
+      subject[:items] = 10
+      subject[:items].should == 10
+    end
+
+    it "should return default value" do
+      subject[:items] = nil
+      subject.get(:items, 15).should == 15
+    end
+  end
+
+  describe ".clear" do
+    it "should remove all settings" do
+      subject[:items] = 5
+
+      redis.hgetall(subject.namespace).should_not be_empty
+      subject.clear
+      redis.hgetall(subject.namespace).should be_empty
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require "active_record"
+require "redis/settings"
+
+Dir[File.dirname(__FILE__) + "/support/**/*.rb"].each {|file| require file}
+
+ActiveRecord::Base.establish_connection :adapter => "sqlite3", :database => ":memory:"
+Redis::Settings.connection = Redis.new(:host => "localhost", :port => 6379)
+
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :users do |t|
+    t.string :login
+  end
+end

data/spec/support/user.rb

@@ -0,0 +1,8 @@
+class User < ActiveRecord::Base
+end
+
+module Admin
+  class User < ActiveRecord::Base
+    set_table_name "users"
+  end
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification 
+name: redis-settings
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Nando Vieira
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-18 00:00:00 -02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: redis
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: ruby-debug19
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: sqlite3-ruby
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+description: Store application and user settings on Redis. Comes with ActiveRecord support.
+email: 
+- fnando.vieira@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.rdoc
+- Rakefile
+- lib/redis-settings.rb
+- lib/redis/settings.rb
+- lib/redis/settings/active_record.rb
+- lib/redis/settings/version.rb
+- redis-settings.gemspec
+- spec/redis/settings/active_record_spec.rb
+- spec/redis/settings_spec.rb
+- spec/spec_helper.rb
+- spec/support/user.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Store application and user settings on Redis. Comes with ActiveRecord support.
+test_files: 
+- spec/redis/settings/active_record_spec.rb
+- spec/redis/settings_spec.rb
+- spec/spec_helper.rb
+- spec/support/user.rb