redis-objects-model 1.0.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in redis-objects-model.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Calvin Walton <calvin.walton@kepstin.ca>
+
+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/README.md

@@ -0,0 +1,35 @@
+# redis-objects-model
+
+The simplest possible Model to use with redis-objects.
+
+The minimum requirement for a class to be usable as a model with
+redis-objects is that it must provide an id attribute. So here is a
+base class that provides an id attribute - lazily yet atomically
+allocated using Redis, of course.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'redis-objects-model'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install redis-objects-model
+
+## Usage
+
+See the generated rdoc, or just read the documentation headers in
+lib/redis-objects-model.rb
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,5 @@
+require 'rubygems/tasks'
+require 'rspec/core/rake_task'
+
+Gem::Tasks.new
+RSpec::Core::RakeTask.new(:spec)

data/lib/redis-objects-model.rb

@@ -0,0 +1,78 @@
+require "redis-objects-model/version"
+require "redis"
+require "redis/objects"
+
+class Redis
+  module Objects
+
+    ##
+    # The simplest possible Model to use with redis-objects.
+    #
+    # The minimum requirement for a class to be usable as a model with
+    # redis-objects is that it must provide an id attribute. So here is a
+    # base class that provides an id attribute - lazily yet atomically
+    # allocated using Redis, of course.
+    #
+    # A few convenience methods are provided to allow you to check whether an
+    # id has been allocated, to do idiomatic 'find' type lookups, and to
+    # create with immediate id allocation.
+    class Model
+      include Redis::Objects
+
+      counter :last_id, :global => true
+
+      ##
+      # Create an instance of the model.
+      #
+      # If the +id+ parameter is not nil, the model will be for the object
+      # with that id. Otherwise, you are creating a new object and a new id
+      # will be allocated atomically as needed.
+      def initialize(id = nil)
+        @id = id
+      end
+
+      ##
+      # Retrieve the id of the object.
+      #
+      # If the instance is referencing an existing object, the id of that
+      # object will be returned. Otherwise a new id will be allocated (and
+      # immediately saved).
+      #
+      # In other words, accessing the id attribute is basically equivalent to
+      # persisting the object.
+      def id
+        @id || @id = last_id.increment
+      end
+
+      #########################################################################
+      # :section: Convenience Methods
+      #########################################################################
+
+      ##
+      # Returns true if no id has been allocated for this object yet.
+      def new_record?
+        @id.nil?
+      end
+
+      ##
+      # Returns false if no id has been allocated for this object yet.
+      def persisted?
+        !new_record?
+      end
+
+      ##
+      # Create a new object, persisting it immediately.
+      def self.create
+        i = self.new
+        i.id
+        i
+      end
+
+      ##
+      # Look up an object by id.
+      def self.find(id)
+        self.new id
+      end
+    end
+  end
+end

data/lib/redis-objects-model/version.rb

@@ -0,0 +1,7 @@
+class Redis
+  module Objects
+    class Model
+      VERSION = "1.0.0"
+    end
+  end
+end

data/redis-objects-model.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'redis-objects-model/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "redis-objects-model"
+  gem.version       = Redis::Objects::Model::VERSION
+  gem.authors       = ["Calvin Walton"]
+  gem.email         = ["calvin.walton@kepstin.ca"]
+  gem.description   = %q{The simplest possible model for redis-objects}
+  gem.summary       = %q{You can't use redis-objects as a model in itself, because it requires an ID attribute. So, lets add one.}
+  gem.homepage      = "https://github.com/kepstin/redis-objects-model"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency('redis-objects', ['~> 0.6.0'])
+  gem.add_development_dependency('fakeredis', ['~>0.4.1'])
+  gem.add_development_dependency('rake', ['~> 10.0.0'])
+  gem.add_development_dependency('rspec', ['~> 2.12.0'])
+  gem.add_development_dependency('rubygems-tasks', ['~> 0.2.3'])
+end

data/spec/redis-objects-model_spec.rb

@@ -0,0 +1,43 @@
+require 'fakeredis'
+require 'redis-objects-model'
+
+describe 'redis-objects-model' do
+  it 'should not be persisted by default' do
+    model = Redis::Objects::Model.new
+    model.should be_new_record
+    model.should_not be_persisted
+  end
+
+  it 'should be persisted after assigning an id' do
+    model = Redis::Objects::Model.new
+    model.id.should > 0
+    model.should_not be_new_record
+    model.should be_persisted
+  end
+
+  it 'should return the same id with multiple calls' do
+    model = Redis::Objects::Model.new
+    id_1 = model.id
+    id_2 = model.id
+    id_1.should == id_2
+  end
+
+  it 'should not create multiple models with the same id' do
+    model_1 = Redis::Objects::Model.new
+    model_2 = Redis::Objects::Model.new
+    model_1.id.should_not == model_2.id
+  end
+
+  it 'should allow being created with an assigned id' do
+    id = Random.rand(1..100000)
+    model = Redis::Objects::Model.new id
+    model.should be_persisted
+    model.id.should == id
+  end
+
+  it 'should be persisted immediately when called with create' do
+    model = Redis::Objects::Model.create
+    model.should be_persisted
+    model.id.should > 0
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: redis-objects-model
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Calvin Walton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis-objects
+  requirement: &7909780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *7909780
+- !ruby/object:Gem::Dependency
+  name: fakeredis
+  requirement: &7908780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  type: :development
+  prerelease: false
+  version_requirements: *7908780
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &7908060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *7908060
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &7907180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+  type: :development
+  prerelease: false
+  version_requirements: *7907180
+- !ruby/object:Gem::Dependency
+  name: rubygems-tasks
+  requirement: &7906040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.3
+  type: :development
+  prerelease: false
+  version_requirements: *7906040
+description: The simplest possible model for redis-objects
+email:
+- calvin.walton@kepstin.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/redis-objects-model.rb
+- lib/redis-objects-model/version.rb
+- redis-objects-model.gemspec
+- spec/redis-objects-model_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/kepstin/redis-objects-model
+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'
+      segments:
+      - 0
+      hash: 866709580333850131
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 866709580333850131
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: You can't use redis-objects as a model in itself, because it requires an
+  ID attribute. So, lets add one.
+test_files:
+- spec/redis-objects-model_spec.rb
+- spec/spec_helper.rb