modis 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c6359a4c5d347150ae7cb19754caf5398fd42d0d
-  data.tar.gz: 330ef4946885313394c85425599e4d1274cda2f8
+  metadata.gz: 9c1496e1e5c9b430c4aa6257d4ec122d3cb1ee37
+  data.tar.gz: 68c023c5b84245530772181c7a2bf564ebe0712f
 SHA512:
-  metadata.gz: dd3275c3569475972681d14c3e1d877d12baf9a872367d4cf0700caf52bb587752414408aeb16afe4886e26a540b5fdcb86da64a0cc6dc3d07dc80b001c4c6e1
-  data.tar.gz: 8527e4159f4b2d7c4ab0c2874518f3de5e24a854b646a26ad5a75be8e4e3d457d47878798167eb6fb1c071c25993ef9984431f9fd13cbb657d350127578f9481
+  metadata.gz: f77b3079fd2c210bb678b952710e188dda3eb1ae8d98d00f30b79b511671305df22a3d5863433c48c2a831bf795580afc8a6c1d6973530a0847e7a5f14cabfad
+  data.tar.gz: d22b018df72ac21e0bce75fba13816ecf7067b96602afae6f0d8d09321d2f24c8c194809d30bc221e543bcbc5bd4330157248eed20ac761c1560d0d647b99ddc

data/.gitignore

@@ -3,7 +3,6 @@
 .bundle
 .config
 .yardoc
-Gemfile.lock
 InstalledFiles
 _yardoc
 coverage

data/.rubocop.yml

@@ -0,0 +1,24 @@
+AllCops:
+  Exclude:
+    - modis.gemspec
+
+LineLength:
+  Enabled: false
+
+StringLiterals:
+  Enabled: false
+
+Documentation:
+  Enabled: false
+
+MethodLength:
+  Enabled: false
+
+ClassLength:
+  Enabled: false
+
+CyclomaticComplexity:
+  Enabled: false
+
+Style/SignalException:
+  EnforcedStyle: only_raise

data/.ruby-version

@@ -1 +1 @@
-ruby-2.1.1
+ruby-2.1.2

data/.travis.yml

@@ -3,6 +3,6 @@ services:
 language: ruby
 rvm:
   - 2.0.0
-  - 2.1.1
+  - 2.1.2
   - jruby
-  - rbx
+  - rbx-2

data/Gemfile

@@ -7,6 +7,7 @@ gem 'coveralls'
 
 platform :mri_19, :mri_20, :mri_21 do
   gem 'cane'
+  gem 'rubocop'
 end
 
 gemspec

data/Gemfile.lock

@@ -0,0 +1,95 @@
+PATH
+  remote: .
+  specs:
+    modis (1.2.0)
+      activemodel (>= 3.0)
+      activesupport (>= 3.0)
+      connection_pool (>= 2)
+      redis (>= 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (4.1.5)
+      activesupport (= 4.1.5)
+      builder (~> 3.1)
+    activesupport (4.1.5)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    ast (2.0.0)
+    builder (3.2.2)
+    cane (2.6.2)
+      parallel
+    connection_pool (2.0.0)
+    coveralls (0.7.1)
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      term-ansicolor
+      thor
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    i18n (0.6.11)
+    json (1.8.1)
+    mime-types (2.3)
+    minitest (5.4.1)
+    multi_json (1.10.1)
+    netrc (0.7.7)
+    parallel (1.3.0)
+    parser (2.2.0.pre.4)
+      ast (>= 1.1, < 3.0)
+      slop (~> 3.4, >= 3.4.5)
+    powerpack (0.0.9)
+    rainbow (2.0.0)
+    rake (10.3.2)
+    redis (3.1.0)
+    rest-client (1.7.2)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.4)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.4)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.4)
+    rubocop (0.25.0)
+      parser (>= 2.2.0.pre.4, < 3.0)
+      powerpack (~> 0.0.6)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.4)
+    ruby-progressbar (1.5.1)
+    simplecov (0.9.0)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    slop (3.6.0)
+    term-ansicolor (1.3.0)
+      tins (~> 1.0)
+    thor (0.19.1)
+    thread_safe (0.3.4)
+    tins (1.3.2)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  cane
+  coveralls
+  modis!
+  rake
+  rspec
+  rubocop
+  simplecov

data/Rakefile

@@ -8,8 +8,10 @@ RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.rspec_opts = ['--backtrace']
 end
 
-if RUBY_VERSION > '1.9' && defined?(RUBY_ENGINE) && RUBY_ENGINE == 'ruby'
-  task :default => 'spec:cane'
+if ENV['TRAVIS'] && ENV['QUALITY'] == 'false'
+  task default: 'spec'
+elsif RUBY_VERSION > '1.9' && defined?(RUBY_ENGINE) && RUBY_ENGINE == 'ruby'
+  task default: 'spec:quality'
 else
-  task :default => 'spec'
+  task default: 'spec'
 end

data/lib/modis/attribute.rb

@@ -0,0 +1,82 @@
+module Modis
+  module Attribute
+    TYPES = [:string, :integer, :float, :timestamp, :boolean, :array, :hash]
+
+    def self.included(base)
+      base.extend ClassMethods
+      base.instance_eval do
+        bootstrap_attributes
+      end
+    end
+
+    module ClassMethods
+      def bootstrap_attributes
+        class << self
+          attr_accessor :attributes
+        end
+
+        self.attributes = {}
+
+        attribute :id, :integer
+      end
+
+      def attribute(name, type = :string, options = {})
+        name = name.to_s
+        raise AttributeError, "Attribute with name '#{name}' has already been specified." if attributes.key?(name)
+        raise UnsupportedAttributeType, type unless TYPES.include?(type)
+
+        attributes[name] = options.update(type: type)
+        define_attribute_methods [name]
+        class_eval <<-EOS, __FILE__, __LINE__
+          def #{name}
+            attributes['#{name}']
+          end
+
+          def #{name}=(value)
+            ensure_type('#{name}', value)
+            #{name}_will_change! unless value == attributes['#{name}']
+            attributes['#{name}'] = value
+          end
+        EOS
+      end
+    end
+
+    def attributes
+      @attributes ||= Hash[self.class.attributes.keys.zip]
+    end
+
+    def assign_attributes(hash)
+      hash.each do |k, v|
+        setter = "#{k}="
+        send(setter, v) if respond_to?(setter)
+      end
+    end
+
+    def write_attribute(key, value)
+      attributes[key.to_s] = value
+    end
+
+    def read_attribute(key)
+      attributes[key.to_s]
+    end
+
+    protected
+
+    def set_sti_type
+      return unless self.class.sti_child?
+      assign_attributes(type: self.class.name)
+    end
+
+    def reset_changes
+      @changed_attributes.clear if @changed_attributes
+    end
+
+    def apply_defaults
+      defaults = {}
+      self.class.attributes.each do |attribute, options|
+        defaults[attribute] = options[:default] if options[:default]
+      end
+      assign_attributes(defaults)
+    end
+  end
+end

data/lib/modis/errors.rb

@@ -5,6 +5,8 @@ module Modis
   class RecordInvalid < ModisError; end
   class UnsupportedAttributeType < ModisError; end
   class AttributeCoercionError < ModisError; end
+  class AttributeError < ModisError; end
+  class IndexError < ModisError; end
 
   module Errors
     def errors

data/lib/modis/finder.rb

@@ -0,0 +1,64 @@
+module Modis
+  module Finder
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def find(id)
+        Modis.with_connection do |redis|
+          attributes = attributes_for(redis, id)
+          model_for(attributes)
+        end
+      end
+
+      def all
+        records = []
+
+        Modis.with_connection do |redis|
+          ids = redis.smembers(key_for(:all))
+          records = redis.pipelined do
+            ids.map { |id| record_for(redis, id) }
+          end
+        end
+
+        records.map do |record|
+          attributes = record_to_attributes(record)
+          model_for(attributes)
+        end
+      end
+
+      def attributes_for(redis, id)
+        raise RecordNotFound, "Couldn't find #{name} without an ID" if id.nil?
+
+        attributes = record_to_attributes(record_for(redis, id))
+
+        unless attributes['id'].present?
+          raise RecordNotFound, "Couldn't find #{name} with id=#{id}"
+        end
+
+        attributes
+      end
+
+      private
+
+      def model_for(attributes)
+        model_class(attributes).new(attributes, new_record: false)
+      end
+
+      def record_to_attributes(record)
+        record.each { |k, v| record[k] = coerce_from_persistence(v) }
+        record
+      end
+
+      def record_for(redis, id)
+        redis.hgetall(key_for(id))
+      end
+
+      def model_class(record)
+        return self if record["type"].blank?
+        record["type"].constantize
+      end
+    end
+  end
+end

data/lib/modis/index.rb

@@ -0,0 +1,92 @@
+module Modis
+  module Index
+    def self.included(base)
+      base.extend ClassMethods
+      base.instance_eval do
+        bootstrap_indexes
+        after__internal_create :add_to_index
+        after__internal_update :update_index
+        before__internal_destroy :remove_from_index
+      end
+    end
+
+    module ClassMethods
+      def bootstrap_indexes
+        class << self
+          attr_accessor :indexed_attributes
+        end
+
+        self.indexed_attributes = []
+      end
+
+      def index(attribute)
+        attribute = attribute.to_s
+        raise IndexError, "No such attribute '#{attribute}'" unless attributes.key?(attribute)
+        indexed_attributes << attribute
+      end
+
+      def where(query)
+        raise IndexError, 'Queries using multiple indexes is not currently supported.' if query.keys.size > 1
+        attribute, value = query.first
+        index = index_for(attribute, value)
+        index.map { |id| find(id) }
+      end
+
+      def index_for(attribute, value)
+        Modis.with_connection do |redis|
+          key = index_key(attribute, value)
+          redis.smembers(key).map(&:to_i)
+        end
+      end
+
+      def index_key(attribute, value)
+        "#{absolute_namespace}:index:#{attribute}:#{value.inspect}"
+      end
+    end
+
+    private
+
+    def indexed_attributes
+      self.class.indexed_attributes
+    end
+
+    def index_key(attribute, value)
+      self.class.index_key(attribute, value)
+    end
+
+    def add_to_index
+      return if indexed_attributes.empty?
+
+      Modis.with_connection do |redis|
+        indexed_attributes.each do |attribute|
+          key = index_key(attribute, read_attribute(attribute))
+          redis.sadd(key, id)
+        end
+      end
+    end
+
+    def remove_from_index
+      return if indexed_attributes.empty?
+
+      Modis.with_connection do |redis|
+        indexed_attributes.each do |attribute|
+          key = index_key(attribute, read_attribute(attribute))
+          redis.srem(key, id)
+        end
+      end
+    end
+
+    def update_index
+      return if indexed_attributes.empty?
+
+      Modis.with_connection do |redis|
+        (changes.keys & indexed_attributes).each do |attribute|
+          old_value, new_value = changes[attribute]
+          old_key = index_key(attribute, old_value)
+          new_key = index_key(attribute, new_value)
+          redis.smove(old_key, new_key, id)
+        end
+      end
+    end
+  end
+end

data/lib/modis/model.rb

@@ -9,16 +9,15 @@ module Modis
         extend ActiveModel::Naming
         extend ActiveModel::Callbacks
 
-        define_model_callbacks :save
-        define_model_callbacks :create
-        define_model_callbacks :update
-        define_model_callbacks :destroy
+        define_model_callbacks :save, :create, :update, :destroy
+        define_model_callbacks :_internal_create, :_internal_update, :_internal_destroy
 
         include Modis::Errors
         include Modis::Transaction
         include Modis::Persistence
-        include Modis::Finders
-        include Modis::Attributes
+        include Modis::Finder
+        include Modis::Attribute
+        include Modis::Index
 
         base.extend(ClassMethods)
       end
@@ -31,20 +30,19 @@ module Modis
       end
     end
 
-    def initialize(record=nil, options={})
+    def initialize(record = nil, options = {})
       set_sti_type
       apply_defaults
       assign_attributes(record.symbolize_keys) if record
       reset_changes
 
-       if options.key?(:new_record)
-        instance_variable_set('@new_record', options[:new_record])
-      end
+      return unless options.key?(:new_record)
+      instance_variable_set('@new_record', options[:new_record])
     end
 
     def ==(other)
       super || other.instance_of?(self.class) && id.present? && other.id == id
     end
-    alias :eql? :==
+    alias_method :eql?, :==
   end
 end

data/lib/modis/persistence.rb

@@ -2,21 +2,25 @@ module Modis
   module Persistence
     def self.included(base)
       base.extend ClassMethods
+      base.instance_eval do
+        after__internal_create :track
+        before__internal_destroy :untrack
+      end
     end
 
     module ClassMethods
       # :nodoc:
       def bootstrap_sti(parent, child)
         child.instance_eval do
-        parent.instance_eval do
-          class << self
+          parent.instance_eval do
+            class << self
               attr_accessor :sti_parent
             end
-            attribute :type, :string
+            attribute :type, :string unless attributes.key?('type')
           end
 
           class << self
-            delegate :attributes, to: :sti_parent
+            delegate :attributes, :indexed_attributes, to: :sti_parent
           end
 
           @sti_child = true
@@ -35,9 +39,7 @@ module Modis
         @namespace = name.split('::').map(&:underscore).join(':')
       end
 
-      def namespace=(value)
-        @namespace = value
-      end
+      attr_writer :namespace
 
       def absolute_namespace
         parts = [Modis.config.namespace, namespace]
@@ -49,9 +51,9 @@ module Modis
       end
 
       def create(attrs)
-          model = new(attrs)
-          model.save
-          model
+        model = new(attrs)
+        model.save
+        model
       end
 
       def create!(attrs)
@@ -59,6 +61,10 @@ module Modis
         model.save!
         model
       end
+
+      def coerce_from_persistence(value)
+        YAML.load(value)
+      end
     end
 
     def persisted?
@@ -73,29 +79,28 @@ module Modis
       defined?(@new_record) ? @new_record : true
     end
 
-    def save(args={})
-      begin
-        create_or_update(args)
-      rescue Modis::RecordInvalid
-        false
-      end
+    def save(args = {})
+      create_or_update(args)
+    rescue Modis::RecordInvalid
+      false
     end
 
-    def save!(args={})
+    def save!(args = {})
       create_or_update(args) || (raise RecordNotSaved)
     end
 
     def destroy
       self.class.transaction do |redis|
         run_callbacks :destroy do
-          redis.del(key)
-          untrack(id, redis)
+          run_callbacks :_internal_destroy do
+            redis.del(key)
+          end
         end
       end
     end
 
     def reload
-      new_attributes = self.class.attributes_for(id)
+      new_attributes = Modis.with_connection { |redis| self.class.attributes_for(redis, id) }
       initialize(new_attributes)
       self
     end
@@ -115,36 +120,69 @@ module Modis
       save!
     end
 
-    protected
+    private
 
-    def create_or_update(args={})
-      skip_validate = args.key?(:validate) && args[:validate] == false
-      if !skip_validate && !valid?
-        raise Modis::RecordInvalid, errors.full_messages.join(', ')
+    def coerce_for_persistence(attribute, value)
+      ensure_type(attribute, value)
+      YAML.dump(value)
+    end
+
+    def ensure_type(attribute, value)
+      type = self.class.attributes[attribute.to_s][:type]
+      type_classes = classes_for_type(type)
+
+      return unless value && !type_classes.include?(value.class)
+      raise Modis::AttributeCoercionError, "Received value of type '#{value.class}', expected '#{type}' for attribute '#{name}'."
+    end
+
+    def classes_for_type(type)
+      { string: [String],
+        integer: [Fixnum],
+        float: [Float],
+        timestamp: [Time],
+        hash: [Hash],
+        array: [Array],
+        boolean: [TrueClass, FalseClass] }[type]
+    end
+
+    def create_or_update(args = {})
+      validate(args)
+      future = persist
+
+      if future && future.value == 'OK'
+        reset_changes
+        @new_record = false
+        new_record? ? add_to_index : update_index
+        true
+      else
+        false
       end
+    end
+
+    def validate(args)
+      skip_validate = args.key?(:validate) && args[:validate] == false
+      return if skip_validate || valid?
+      raise Modis::RecordInvalid, errors.full_messages.join(', ')
+    end
 
+    def persist
       future = nil
       set_id if new_record?
+      callback = new_record? ? :create : :update
 
       self.class.transaction do |redis|
         run_callbacks :save do
-          callback = new_record? ? :create : :update
           run_callbacks callback do
-            attrs = []
-            attributes.each { |k, v| attrs << k << coerce_to_string(k, v) }
-            future = redis.hmset(self.class.key_for(id), attrs)
-            track(id, redis) if new_record?
+            run_callbacks "_internal_#{callback}" do
+              attrs = []
+              attributes.each { |k, v| attrs << k << coerce_for_persistence(k, v) }
+              future = redis.hmset(self.class.key_for(id), attrs)
+            end
           end
         end
       end
 
-      if future && future.value == 'OK'
-        reset_changes
-        @new_record = false
-        true
-      else
-        false
-      end
+      future
     end
 
     def set_id
@@ -153,12 +191,12 @@ module Modis
       end
     end
 
-    def track(id, redis)
-      redis.sadd(self.class.key_for(:all), id)
+    def track
+      Modis.with_connection { |redis| redis.sadd(self.class.key_for(:all), id) }
     end
 
-    def untrack(id, redis)
-      redis.srem(self.class.key_for(:all), id)
+    def untrack
+      Modis.with_connection { |redis| redis.srem(self.class.key_for(:all), id) }
     end
   end
 end

data/lib/modis/version.rb

@@ -1,3 +1,3 @@
 module Modis
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end