sequel_enum 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 08f97db0b4aece1769c75037b639cd7d8f2c5af4
+  data.tar.gz: 464bea4508eefc6436ca91ddfaeb242a554799f4
+SHA512:
+  metadata.gz: cd69833c833f6885c9ec7e4e504cdc5e5fbae80e409d7cca3a9befc235b4095e72f5de464d873538980acd659f0b0d2455532446b779450edf62e0e62b685ec2
+  data.tar.gz: 450fdfe9efcb8ab77832f07bc1b2fde0dea212344e01a1da65c7f2e3619323855a12b7705b6f45d512e035317ccae9257400ee554958a55e82e3e9d1ebd82a3d

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 sequel_enum.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Adrià Planas
+
+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,56 @@
+# Sequel_enum
+
+A Sequel plugin that provides enum-like functionality to your models.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sequel_enum'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sequel_enum
+
+## Usage
+
+```ruby
+class Item < Sequel::Model
+  plugin :enum
+  enum :condition, [:mint, :good, :poor]
+end
+
+item = Item.new
+item.condition = :mint
+
+item.condition #> :mint
+item.mint? #> true
+item.good? #> false
+```
+
+```#enum``` accepts a hash like ```{ index => value }``` as well:
+
+```ruby
+class Item < Sequel::Model
+  plugin :enum
+  enum :condition, {10 => :mint, 11 => :good, 15 => :poor}
+end
+
+item = Item.new
+item.condition = :mint
+
+item[:condition] #> 10
+```
+
+
+## Contributing
+
+1. Fork it ( http://github.com/planas/sequel_enum/fork )
+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 @@
+require "bundler/gem_tasks"

data/lib/sequel_enum.rb

@@ -0,0 +1,45 @@
+module Sequel
+  module Plugins
+    module Enum
+      def self.apply(model, opts = OPTS)
+        model.instance_eval do
+          @enums = {}
+        end
+      end
+
+      module ClassMethods
+        attr_reader :enums
+
+        def enum(column, values)
+          if values.is_a? Hash
+            values.each do |key,val|
+              raise ArgumentError, "index should be numeric, #{key} provided wich it's a #{key.class}" unless key.is_a? Fixnum
+              raise ArgumentError "value should be a symbol, #{val} provided wich it's a #{val.class}" unless val.is_a? Symbol
+            end
+          elsif values.is_a? Array
+            values = Hash[values.map.with_index { |v, i| [i,v] }]
+          else
+            raise ArgumentError, "#enum expects the second argument to be an array of symbols or a hash like { index => :value }"
+          end
+
+          define_method "#{column}=" do |value|
+            index = self.class.enums[column].rassoc(value)
+            self[column] = index && index.first
+          end
+
+          define_method "#{column}" do
+            self.class.enums[column].fetch(self[column], nil)
+          end
+
+          values.each do |key, value|
+            define_method "#{value}?" do
+              self.send(column) == value
+            end
+          end
+
+          enums[column] = values
+        end
+      end
+    end
+  end
+end

data/lib/sequel_enum/version.rb

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

data/sequel_enum.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'sequel_enum/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sequel_enum"
+  spec.version       = SequelEnum::VERSION
+  spec.authors       = ["Adrià Planas"]
+  spec.email         = ["adriaplanas@liquidcodeworks.com"]
+  spec.summary       = %q{A Sequel plugin that provides enum-like functionality to your models}
+  spec.homepage      = "https://github.com/planas/sequel_enum"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "sequel"
+
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rspec",   "~> 2.0"
+  spec.add_development_dependency "sqlite3", "~> 1.3"
+end

data/spec/sequel_enum_spec.rb

@@ -0,0 +1,92 @@
+require 'spec_helper'
+
+class Item < Sequel::Model
+  plugin :enum
+end
+
+describe "sequel_enum" do
+  let(:item) { Item.new }
+
+  specify "class should provide reflection" do
+    Item.enum :condition, [:mint, :very_good, :fair]
+    Item.enums.should eq({ condition: { 0 => :mint, 1 => :very_good, 2 => :fair}})
+  end
+
+  specify "it accepts an array of symbols" do
+    expect{
+      Item.enum :condition, [:mint, :very_good, :good, :poor]
+    }.not_to raise_error
+  end
+
+  specify "it accepts a hash of index => value" do
+    expect{
+      Item.enum :condition, 0 => :mint, 1 => :very_good, 2 => :good, 3 => :poor
+    }.not_to raise_error
+  end
+
+  specify "it rejects an invalid hash" do
+    expect{
+      Item.enum :condition, { '0' => :mint }
+    }.to raise_error(ArgumentError)
+  end
+
+  specify "it rejects when it's not an array or hash" do
+    expect{
+      Item.enum :condition, 'whatever'
+    }.to raise_error(ArgumentError)
+  end
+
+  describe "methods" do
+    before(:all) do
+      Item.enum :condition, [:mint, :very_good, :good, :poor]
+    end
+
+    describe "#column=" do
+      context "with a valid value" do
+        it "should set column to the value index" do
+          item.condition = :mint
+          item[:condition].should eq 0
+        end
+      end
+
+      context "with an invalid value" do
+        it "should set column to nil" do
+          item.condition = :fair
+          item[:condition].should be_nil
+        end
+      end
+    end
+
+    describe "#column" do
+      context "with a valid index stored on the column" do
+        it "should return its matching value" do
+          item[:condition] = 1
+          item.condition.should eq :very_good
+        end
+      end
+
+      context "with an invalid index stored on the column" do
+        it "should return nil" do
+          item[:condition] = 10
+          item.condition.should be_nil
+        end
+      end
+    end
+
+    describe "#column?" do
+      context "when the actual value match" do
+        it "should return true" do
+          item.condition = :good
+          item.good?.should eq true
+        end
+      end
+
+      context "when the actual value doesn't match" do
+        it "should return false" do
+          item.condition = :mint
+          item.poor?.should eq false
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+require 'sequel'
+require 'sqlite3'
+require 'sequel_enum'
+
+DB = Sequel.connect('sqlite://test.db')
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.order = 'random'
+
+  config.before(:suite) do
+    DB.create_table :items do
+      primary_key :id
+      column :name, String
+      column :condition, Integer
+    end
+  end
+
+  config.after(:suite) do
+    DB.drop_table :items
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: sequel_enum
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Adrià Planas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: 
+email:
+- adriaplanas@liquidcodeworks.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sequel_enum.rb
+- lib/sequel_enum/version.rb
+- sequel_enum.gemspec
+- spec/sequel_enum_spec.rb
+- spec/spec_helper.rb
+- test.db
+homepage: https://github.com/planas/sequel_enum
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A Sequel plugin that provides enum-like functionality to your models
+test_files:
+- spec/sequel_enum_spec.rb
+- spec/spec_helper.rb