ohm-contrib 0.1.2 → 1.0.rc0

data/lib/ohm/{contrib/callbacks.rb → callbacks.rb}

@@ -4,8 +4,6 @@ module Ohm
   # You can implement callbacks by overriding any of the following
   # methods:
   #
-  #    - before_validate
-  #    - after_validate
   #    - before_create
   #    - after_create
   #    - before_save
@@ -22,8 +20,6 @@ module Ohm
   #   class Post < Ohm::Model
   #     include Ohm::Callbacks
   #
-  #     before :validate, :clean_decimals
-  #
   #     before :create, :timestamp!
   #     before :save,   :recalc_votes
   #
@@ -53,11 +49,11 @@ module Ohm
   #   end
 
   module Callbacks
-    def self.included(base)
-      base.extend Macros
+    def self.included(model)
+      model.extend ClassMethods
     end
 
-    module Macros
+    module ClassMethods
       # Use to add a before callback on `method`. Only symbols
       # are allowed, no string eval, no block option also.
       #
@@ -79,12 +75,12 @@ module Ohm
       #     end
       #   end
       #
-      # @param [Symbol] method the method type, `:validate`, `:create`, or `:save`
+      # @param [Symbol] method the method type, e.g. `:create`, or `:save`
       # @param [Symbol] callback the name of the method to execute
       # @return [Array] the callback in an array if added e.g. [:timestamp]
       # @return [nil] if the callback already exists
       def before(method, callback)
-        unless callbacks[:before][method].include? callback
+        unless callbacks[:before][method].include?(callback)
           callbacks[:before][method] << callback
         end
       end
@@ -115,7 +111,7 @@ module Ohm
       # @return [Array] the callback in an array if added e.g. [:timestamp]
       # @return [nil] if the callback already exists
       def after(method, callback)
-        unless callbacks[:after][method].include? callback
+        unless callbacks[:after][method].include?(callback)
           callbacks[:after][method] << callback
         end
       end
@@ -126,76 +122,35 @@ module Ohm
       end
     end
 
-    # Overrides the validate method of Ohm::Model. This is a bit tricky,
-    # since typically you override this. Make sure you do something like:
-    #
-    #   def validate
-    #     super
-    #
-    #     # do your assertions
-    #   end
-    #
-    # This ensures that you call this method when you defined your own validate
-    # method.
-    #
-    # In all honesty, I don't see the value of putting this here, and I'm still
-    # weighing if this is _really_ needed.
-    def validate
-      execute_callback(:before, :validate)
-      super
-      execute_callback(:after, :validate)
-    end
-
     # The overriden create of Ohm::Model. It checks if the
     # model is valid, and executes all before :create callbacks.
     #
     # If the create succeeds, all after :create callbacks are
     # executed.
-    def create
-      return unless valid?
+    def write
+      creating = @creating
 
-      execute_callback(:before, :create)
+      execute_callback(:before, :create) if creating
+      execute_callback(:before, :update) unless creating
       execute_callback(:before, :save)
 
-      initialize_id
-
-      mutex do
-        create_model_membership
-        write
-        add_to_indices
+      super
 
-        execute_callback(:after, :create)
-        execute_callback(:after, :save)
-      end
+      execute_callback(:after, :create) if creating
+      execute_callback(:after, :update) unless creating
+      execute_callback(:after, :save)
     end
 
-    # The overridden save of Ohm::Model. It checks if the model
-    # is valid, and executes all before :save callbacks.
-    #
-    # If the save also succeeds, all after :save callbacks are
-    # executed.
-    def save
-      return create if new?
-      return unless valid?
-
-      execute_callback(:before, :save)
-      execute_callback(:before, :update)
-
-      mutex do
-        write
-        update_indices
-
-        execute_callback(:after, :save)
-        execute_callback(:after, :update)
-      end
+    def create
+      @creating = true
+      super
+      @creating = false
     end
 
     def delete
       execute_callback(:before, :delete)
-
-      super.tap do |is_deleted|
-        execute_callback(:after, :delete)  if is_deleted
-      end
+      super
+      execute_callback(:after, :delete)
     end
 
   protected

data/lib/ohm/contrib.rb

@@ -1,21 +1,13 @@
+require_relative "callbacks"
+require_relative "datatypes"
+require_relative "locking"
+require_relative "scope"
+require_relative "slug"
+require_relative "softdelete"
+require_relative "timestamping"
+
 module Ohm
   module Contrib
-    VERSION = "0.1.2"
+    VERSION = "1.0.rc0"
   end
-
-  autoload :ActiveModelExtension, "ohm/contrib/active_model_extension"
-  autoload :Boundaries,           "ohm/contrib/boundaries"
-  autoload :Timestamping,         "ohm/contrib/timestamping"
-  autoload :LengthValidations,    "ohm/contrib/length_validations"
-  autoload :WebValidations,       "ohm/contrib/web_validations"
-  autoload :NumberValidations,    "ohm/contrib/number_validations"
-  autoload :DateValidations,      "ohm/contrib/date_validations"
-  autoload :ExtraValidations,     "ohm/contrib/extra_validations"
-  autoload :Typecast,             "ohm/contrib/typecast"
-  autoload :Locking,              "ohm/contrib/locking"
-  autoload :Callbacks,            "ohm/contrib/callbacks"
-  autoload :Slug,                 "ohm/contrib/slug"
-  autoload :Scope,                "ohm/contrib/scope"
-  autoload :SoftDelete,           "ohm/contrib/soft_delete"
-  autoload :FulltextSearching,    "ohm/contrib/fulltext_searching"
 end

data/lib/ohm/datatypes.rb

@@ -0,0 +1,38 @@
+require "bigdecimal"
+require "date"
+require "json"
+require "time"
+
+module Ohm
+  module DataTypes
+    module Type
+      Integer   = lambda { |x| x.to_i }
+      Decimal   = lambda { |x| x && BigDecimal(x.to_s) }
+      Float     = lambda { |x| x.to_f }
+      Boolean   = lambda { |x| !!x }
+      Time      = lambda { |t| t && (t.kind_of?(::Time) ? t : ::Time.parse(t)) }
+      Date      = lambda { |d| d && (d.kind_of?(::Date) ? d : ::Date.parse(d)) }
+      Timestamp = lambda { |t| t && UnixTime.at(t.to_i) }
+      Hash      = lambda { |h| h && (h.kind_of?(::Hash) ? SerializedHash[h] : JSON(h)) }
+      Array     = lambda { |a| a && (a.kind_of?(::Array) ? SerializedArray.new(a) : JSON(a)) }
+    end
+
+    class UnixTime < Time
+      def to_s
+        to_i.to_s
+      end
+    end
+
+    class SerializedHash < Hash
+      def to_s
+        JSON.dump(self)
+      end
+    end
+
+    class SerializedArray < Array
+      def to_s
+        JSON.dump(self)
+      end
+    end
+  end
+end

data/lib/ohm/{contrib/locking.rb → locking.rb}

@@ -52,5 +52,4 @@ module Ohm
       lock.to_f < Time.now.to_f
     end
   end
-end
-
+end

data/lib/ohm/plugin.rb

@@ -0,0 +1,54 @@
+module Ohm
+  module Plugin
+    def plugin(name)
+      mixin = Plugin[name]
+
+      include mixin
+      extend  mixin::ClassMethods if mixin.const_defined?(:ClassMethods, false)
+
+      mixin.setup(self) if mixin.respond_to?(:setup)
+    end
+
+    def self.[](plugin)
+      case plugin
+      when Module
+        plugin
+      when Symbol
+        name, path = Plugin.registry[plugin]
+
+        raise Unknown.new(plugin) if name.nil?
+
+        require path
+        Ohm.const_get(name, false)
+      else
+        raise Unknown.new(plugin)
+      end
+    end
+
+    def self.register(name, name_and_path)
+      registry[name] = name_and_path
+    end
+
+    def self.registry
+      @registry ||= {
+        :callbacks     => [:Callbacks,    "ohm/contrib/callbacks"],
+        :datatypes     => [:DataTypes,    "ohm/contrib/data_types"],
+        :locking       => [:Locking,      "ohm/contrib/locking"],
+        :scope         => [:Scope,        "ohm/contrib/scope"],
+        :slug          => [:Slug,         "ohm/contrib/slug"],
+        :softdelete    => [:SoftDelete,   "ohm/contrib/soft_delete"],
+        :timestamping  => [:Timestamping, "ohm/contrib/timestamping"]
+      }
+    end
+
+    class Unknown < StandardError
+      def initialize(plugin)
+        @plugin = plugin
+      end
+
+      def message
+        "Unknown plugin: #{@plugin}"
+      end
+    end
+  end
+end

data/lib/ohm/{contrib/scope.rb → scope.rb}

@@ -1,14 +1,14 @@
 module Ohm
   module Scope
-    def self.included(base)
-      unless defined?(base::DefinedScopes)
-        base.const_set(:DefinedScopes, Module.new)
+    def self.included(model)
+      unless model.const_defined?(:DefinedScopes, false)
+        model.const_set(:DefinedScopes, Module.new)
       end
 
-      base.extend Macros
+      model.extend ClassMethods
     end
 
-    module Macros
+    module ClassMethods
       def scope(scope = nil, &block)
         self::DefinedScopes.module_eval(&block) if block_given?
         self::DefinedScopes.send(:include, scope) if scope
@@ -25,5 +25,6 @@ module Ohm
 
     Ohm::Model::Set.send :include, OverloadedSet
   end
-end
 
+  Model::Set.send :include, Scope::OverloadedSet
+end

data/lib/ohm/{contrib/slug.rb → slug.rb}

@@ -1,17 +1,17 @@
 module Ohm
   module Slug
-    def self.included(base)
-      base.extend FinderOverride
+    def self.included(model)
+      model.extend ClassMethods
     end
 
-    module FinderOverride
+    module ClassMethods
       def [](id)
         super(id.to_i)
       end
     end
 
     def slug(str = to_s)
-      ret = iconv(str)
+      ret = transcode(str)
       ret.gsub!("'", "")
       ret.gsub!(/\p{^Alnum}/u, " ")
       ret.strip!
@@ -20,16 +20,21 @@ module Ohm
     end
     module_function :slug
 
-    def iconv(str)
+    def transcode(str)
       begin
+        # TODO: replace with a String#encode version which will
+        # contain proper transliteration tables. For now, Iconv
+        # still wins because we get that for free.
+        v, $VERBOSE = $VERBOSE, nil
         require "iconv"
+        $VERBOSE = v
 
         Iconv.iconv("ascii//translit//ignore", "utf-8", str)[0]
       rescue LoadError
         return str
       end
     end
-    module_function :iconv
+    module_function :transcode
 
     def to_param
       "#{ id }-#{ slug }"

data/lib/ohm/{contrib/soft_delete.rb → softdelete.rb}

@@ -4,7 +4,7 @@ module Ohm
   # @example
   #
   #   class Post < Ohm::Model
-  #     include Ohm::SoftDelete
+  #     plugin :softdelete
   #
   #     attribute :title
   #     index :title
@@ -23,7 +23,7 @@ module Ohm
   #   Post.all.empty?
   #   # => true
   #
-  #   Post.find(:title => 'Title').empty?
+  #   Post.find(:title => 'Title').include?(post)
   #   # => true
   #
   #   Post.exists?(post.id)
@@ -34,35 +34,39 @@ module Ohm
   #   post.deleted?
   #   # => true
   module SoftDelete
-    IS_DELETED = "1"
+    DELETED_FLAG = "1"
 
-    def self.included(base)
-      base.attribute :deleted
-      base.index :deleted
-      base.extend ClassMethods
+    def self.included(model)
+      model.attribute :deleted
+
+      model.extend ClassMethods
     end
 
     def delete
-      update(:deleted => IS_DELETED)
-    end
+      self.class.all.delete(self)
+      self.class.deleted.add(self)
 
-    def deleted?
-      deleted == IS_DELETED
+      update(deleted: DELETED_FLAG)
     end
 
-  private
-    def create_model_membership
-      self.class.key[:all].sadd(self.id)
+    def restore
+      self.class.all.add(self)
+      self.class.deleted.delete(self)
+
+      update(deleted: nil)
     end
 
-    def delete_model_membership
-      key.del
-      self.class.key[:all].srem(self.id)
+    def deleted?
+      deleted == DELETED_FLAG
     end
 
     module ClassMethods
-      def all
-        super.except(:deleted => IS_DELETED)
+      def deleted
+        Model::Set.new(key[:deleted], Model::Wrapper.wrap(self))
+      end
+
+      def exists?(id)
+        super || key[:deleted].sismember(id)
       end
     end
   end

data/lib/ohm/timestamping.rb

@@ -0,0 +1,41 @@
+require_relative "callbacks"
+require_relative "datatypes"
+
+module Ohm
+  # Provides created_at / updated_at timestamps.
+  #
+  # @example
+  #
+  #   class Post < Ohm::Model
+  #     include Ohm::Timestamping
+  #   end
+  #
+  #   post = Post.create
+  #   post.created_at.to_s == Time.now.utc.to_s
+  #   # => true
+  #
+  #   post = Post[post.id]
+  #   post.save
+  #   post.updated_at.to_s == Time.now.utc.to_s
+  #   # => true
+  module Timestamping
+    def self.included(model)
+      model.send :include, Callbacks
+
+      model.attribute :created_at, DataTypes::Type::Timestamp
+      model.attribute :updated_at, DataTypes::Type::Timestamp
+
+      model.before :create, :set_created_at
+      model.before :save,   :set_updated_at
+    end
+
+  protected
+    def set_created_at
+      self.created_at ||= Time.now.utc.to_i
+    end
+
+    def set_updated_at
+      self.updated_at = Time.now.utc.to_i
+    end
+  end
+end

data/ohm-contrib.gemspec

@@ -0,0 +1,30 @@
+Gem::Specification.new do |s|
+  s.name = "ohm-contrib"
+  s.version = "1.0.rc0"
+  s.summary = %{A collection of decoupled drop-in modules for Ohm.}
+  s.description = %{Includes a couple of core functions such as callbacks, timestamping, typecasting and lots of generic validation routines.}
+  s.author = "Cyril David"
+  s.email = "cyx.ucron@gmail.com"
+  s.homepage = "http://github.com/cyx/ohm-contrib"
+
+  s.specification_version = 2 if s.respond_to? :specification_version=
+
+  s.files = Dir[
+    "LICENSE",
+    "README.markdown",
+    "rakefile",
+    "lib/**/*.rb",
+    "*.gemspec",
+    "test/*.*",
+  ]
+
+  s.require_paths = ["lib"]
+  s.rubyforge_project = "ohm-contrib"
+
+  s.has_rdoc = false
+  s.add_dependency "ohm"
+
+  s.add_development_dependency "cutest"
+  s.add_development_dependency "redis"
+  s.add_development_dependency "override"
+end

data/rakefile

@@ -0,0 +1,6 @@
+task :test do
+  require 'cutest'
+  $:.unshift('./lib', './test')
+
+  Cutest.run(Dir['./test/*.rb'])
+end

data/test/{instance_callbacks_test.rb → instance_callbacks.rb}

@@ -1,6 +1,6 @@
 # encoding: UTF-8
 
-require File.expand_path("./helper", File.dirname(__FILE__))
+require_relative "helper"
 
 class Post < Ohm::Model
   include Ohm::Callbacks
@@ -22,8 +22,6 @@ class Post < Ohm::Model
   end
 
 protected
-  def before_validate() incr(:do_before_validate) end
-  def after_validate()  incr(:do_after_validate)  end
   def before_create()   incr(:do_before_create)   end
   def after_create()    incr(:do_after_create)    end
   def before_save()     incr(:do_before_save)     end
@@ -33,7 +31,6 @@ protected
   def before_delete()   incr(:do_before_delete)   end
   def after_delete()    incr(:do_after_delete)    end
 
-
   def incr(action)
     val = instance_variable_get("@#{ action }")
     val ||= 0
@@ -43,5 +40,4 @@ protected
   end
 end
 
-load File.expand_path('./callbacks_lint.rb', File.dirname(__FILE__))
-
+load File.expand_path('lint/callbacks.rb', File.dirname(__FILE__))

data/test/{macro_callbacks_test.rb → macro_callbacks.rb}

@@ -7,9 +7,6 @@ class Post < Ohm::Model
 
   attribute :body
 
-  before :validate, :do_before_validate
-  after  :validate, :do_after_validate
-
   before :create,   :do_before_create
   after  :create,   :do_after_create
 
@@ -23,8 +20,6 @@ class Post < Ohm::Model
   after  :update,   :do_after_update
 
   def validate
-    super
-
     assert_present :body
   end
 
@@ -37,8 +32,6 @@ class Post < Ohm::Model
   end
 
 protected
-  def do_before_validate() incr(:do_before_validate) end
-  def do_after_validate()  incr(:do_after_validate)  end
   def do_before_create()   incr(:do_before_create)   end
   def do_after_create()    incr(:do_after_create)    end
   def do_before_save()     incr(:do_before_save)     end
@@ -58,5 +51,4 @@ protected
   end
 end
 
-load File.expand_path('./callbacks_lint.rb', File.dirname(__FILE__))
-
+load File.expand_path('lint/callbacks.rb', File.dirname(__FILE__))