rails_soft_deletable 0.0.5 → 0.0.7

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NWUwMzNmMjUxZDEyOGQ0NTNkMDBhMjViYTEyOTQ1NjdiNGRlYThkMA==
+  data.tar.gz: !binary |-
+    YjYzZjFiYTdmNzZlMjI3OWJkMzVkZjZhN2JmNTc5ZDZjNTI4MDJkYw==
+SHA512:
+  metadata.gz: !binary |-
+    N2I5YmNjZDljZmYzZjBiMzk4ZmFlNjk0OTNmNmU1ZTA5ZDkxYmI1MTdkMTNj
+    N2FkYmNhYjdkZGFmYzRjMDJiMzYyMmQzZDcwMTdkZjNjZmRiMzBiMTY4YjUw
+    NjQ4YTNhY2IwMzk2ODRlNWJhN2UyYjY1ZDNjMWUyZDVlZTZmYjA=
+  data.tar.gz: !binary |-
+    MjM2NzQzNmE5MTZiMzNlODA5ZTg0YWQzYTUzZDkwNWU5ZjViNmZmNDQxN2E3
+    ZDFkZGMxZjAxMzZlYjk1YmExMDNmMGMxYjgyMGY1ODQ5ZTAwZTI1NjU0NzU3
+    NTdjYTc4NmM0YWVhYWU4MjczNjBmZTFiNWU0OGIwMWYwZWRkZjI=

data/lib/rails_soft_deletable.rb

@@ -1,175 +1,5 @@
 require "rails_soft_deletable/version"
-require "active_record"
+require "rails_soft_deletable/rails/railtie"
 
 module RailsSoftDeletable
-  def self.included(base)
-    base.extend Query
-    base.extend Callbacks
-  end
-
-  module Query
-    def soft_deletable?
-      true
-    end
-
-    def with_deleted
-      scoped.tap { |x| x.default_scoped = false }
-    end
-
-    def only_deleted
-      with_deleted.where("#{self.table_name}.#{soft_deletable_column} > 0")
-    end
-    alias :deleted :only_deleted
-
-    def restore(id)
-      if id.is_a?(Array)
-        id.map { |one_id| restore(one_id) }
-      else
-        only_deleted.find(id).restore!
-      end
-    end
-  end
-
-  module Callbacks
-    def self.extended(base)
-      base.define_callbacks :restore
-
-      base.define_singleton_method("before_restore") do |*args, &block|
-        set_callback(:restore, :before, *args, &block)
-      end
-
-      base.define_singleton_method("around_restore") do |*args, &block|
-        set_callback(:restore, :around, *args, &block)
-      end
-
-      base.define_singleton_method("after_restore") do |*args, &block|
-        set_callback(:restore, :after, *args, &block)
-      end
-    end
-  end
-
-  def soft_delete_time
-    value = send(soft_deletable_column)
-    if value.zero? || value.nil?
-      nil
-    else
-      Time.at(value).in_time_zone
-    end
-  end
-
-  def destroy(destroy_mode = :soft)
-    if destroy_mode == :hard
-      _original_destroy
-    else
-      if destroyed?
-        delete_or_soft_delete(true)
-      else
-        run_callbacks(:destroy) { delete_or_soft_delete(true) }
-      end
-    end
-  end
-
-  def delete(delete_mode = :soft)
-    if delete_mode == :hard
-      _original_delete
-    else
-      return if new_record?
-      delete_or_soft_delete
-    end
-  end
-
-  def restore!
-    run_callbacks(:restore) do
-      # XXX: Rails >3.2.11 fixes an issue with update_column:
-      # https://github.com/rails/rails/commit/a3c3cfdd0ebba26bb9dfc0bfd4e23a5f336730c0
-      # Since we're on 3.2.11, we cannot use update_column.
-      #   update_column(soft_deletable_column, 0)
-
-      name = soft_deletable_column.to_s
-      updated_count = self.class.unscoped.update_all({ name => 0 }, self.class.primary_key => id)
-      raw_write_attribute(name, 0)
-
-      updated_count == 1
-    end
-  end
-  alias :restore :restore!
-
-  def destroyed?
-    value = send(soft_deletable_column)
-    !value || value != 0
-  end
-
-  def persisted?
-    @_pretend_persistence || super
-  end
-
-  private
-
-  def _prepare_for_hard_delete(&block)
-    @_pretend_persistence = true
-    self.class.unscoped(&block)
-  ensure
-    @_pretend_persistence = false
-  end
-
-  def delete_or_soft_delete(with_transaction = false)
-    if destroyed?
-      _prepare_for_hard_delete { _original_delete }
-    else
-      touch_soft_deletable_column(with_transaction)
-    end
-  end
-
-  def touch_soft_deletable_column(with_transaction=false)
-    if with_transaction
-      with_transaction_returning_status { touch_column }
-    else
-      touch_column
-    end
-  end
-
-  def touch_column
-    raise ActiveRecordError, "can not touch on a new record object" unless persisted?
-
-    current_time = ("%0.6f" % current_time_from_proper_timezone).to_f
-    changes = {}
-
-    changes[soft_deletable_column.to_s] = write_attribute(soft_deletable_column.to_s, current_time)
-
-    changes[self.class.locking_column] = increment_lock if locking_enabled?
-
-    @changed_attributes.except!(*changes.keys)
-    primary_key = self.class.primary_key
-    self.class.unscoped.where(primary_key => self[primary_key]).update_all(changes) == 1
-  end
-end
-
-class ActiveRecord::Base
-  def self.soft_deletable(options={})
-    alias :_original_destroy :destroy
-    alias :_original_delete  :delete
-
-    private :_original_destroy
-    private :_original_delete
-
-    include RailsSoftDeletable
-    class_attribute :soft_deletable_column
-
-    self.soft_deletable_column = options[:column] || :deleted_at
-    default_scope { where(self.quoted_table_name + ".#{soft_deletable_column} = 0") }
-  end
-
-  def self.soft_deletable?
-    false
-  end
-
-  def soft_deletable?
-    self.class.soft_deletable?
-  end
-
-  private
-
-  def soft_deletable_column
-    self.class.soft_deletable_column
-  end
 end

data/lib/rails_soft_deletable/callbacks.rb

@@ -0,0 +1,119 @@
+require "active_support/concern"
+
+module RailsSoftDeletable
+  module Callbacks
+    extend ActiveSupport::Concern
+
+    included do
+      define_callbacks :restore
+
+      define_singleton_method("before_restore") do |*args, &block|
+        set_callback(:restore, :before, *args, &block)
+      end
+
+      define_singleton_method("around_restore") do |*args, &block|
+        set_callback(:restore, :around, *args, &block)
+      end
+
+      define_singleton_method("after_restore") do |*args, &block|
+        set_callback(:restore, :after, *args, &block)
+      end
+    end
+
+    def soft_delete_time
+      value = send(soft_deletable_column)
+
+      if value.zero? || value.nil?
+        nil
+      else
+        Time.at(value).in_time_zone
+      end
+    end
+
+    def destroy(destroy_mode = :soft)
+      if destroy_mode == :hard
+        super()
+      else
+        if destroyed?
+          delete_or_soft_delete(true)
+        else
+          run_callbacks(:destroy) { delete_or_soft_delete(true) }
+        end
+      end
+    end
+
+    def delete(delete_mode = :soft)
+      if delete_mode == :hard
+        super()
+      else
+        return if new_record?
+        delete_or_soft_delete
+      end
+    end
+
+    def restore!
+      run_callbacks(:restore) do
+        # XXX: Rails >3.2.11 fixes an issue with update_column:
+        # https://github.com/rails/rails/commit/a3c3cfdd0ebba26bb9dfc0bfd4e23a5f336730c0
+        # Since we're on 3.2.11, we cannot use update_column.
+        #   update_column(soft_deletable_column, 0)
+
+        name = soft_deletable_column.to_s
+        updated_count = self.class.unscoped.update_all({ name => 0 }, self.class.primary_key => id)
+        raw_write_attribute(name, 0)
+
+        updated_count == 1
+      end
+    end
+    alias :restore :restore!
+
+    def destroyed?
+      value = send(soft_deletable_column)
+      !value || value != 0
+    end
+
+    def persisted?
+      @_pretend_persistence || super
+    end
+
+    private
+
+    def _prepare_for_hard_delete(&block)
+      @_pretend_persistence = true
+      self.class.unscoped(&block)
+    ensure
+      @_pretend_persistence = false
+    end
+
+    def delete_or_soft_delete(with_transaction = false)
+      if destroyed?
+        _prepare_for_hard_delete { delete(:hard) }
+      else
+        touch_soft_deletable_column(with_transaction)
+      end
+    end
+
+    def touch_soft_deletable_column(with_transaction=false)
+      if with_transaction
+        with_transaction_returning_status { touch_column }
+      else
+        touch_column
+      end
+    end
+
+    def touch_column
+      raise ActiveRecordError, "can not touch on a new record object" unless persisted?
+
+      current_time = ("%0.6f" % current_time_from_proper_timezone).to_f
+      changes = {}
+
+      changes[soft_deletable_column.to_s] = write_attribute(soft_deletable_column.to_s, current_time)
+
+      changes[self.class.locking_column] = increment_lock if locking_enabled?
+
+      @changed_attributes.except!(*changes.keys)
+      primary_key = self.class.primary_key
+      self.class.unscoped.where(primary_key => self[primary_key]).update_all(changes) == 1
+    end
+  end
+end

data/lib/rails_soft_deletable/query.rb

@@ -0,0 +1,30 @@
+require "active_support/concern"
+
+module RailsSoftDeletable
+  module Query
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def soft_deletable?
+        true
+      end
+
+      def with_deleted
+        scoped.tap { |x| x.default_scoped = false }
+      end
+
+      def only_deleted
+        with_deleted.where("#{self.table_name}.#{soft_deletable_column} > 0")
+      end
+      alias :deleted :only_deleted
+
+      def restore(id)
+        if id.is_a?(Array)
+          id.map { |one_id| restore(one_id) }
+        else
+          only_deleted.find(id).restore!
+        end
+      end
+    end
+  end
+end

data/lib/rails_soft_deletable/rails/active_record.rb

@@ -0,0 +1,34 @@
+require "rails_soft_deletable/query"
+require "rails_soft_deletable/callbacks"
+
+module RailsSoftDeletable
+  module ActiveRecord
+    extend ActiveSupport::Concern
+
+    def soft_deletable?
+      self.class.soft_deletable?
+    end
+
+    private
+
+    def soft_deletable_column
+      self.class.soft_deletable_column
+    end
+
+    module ClassMethods
+      def soft_deletable(options={})
+        include RailsSoftDeletable::Query
+        include RailsSoftDeletable::Callbacks
+
+        class_attribute :soft_deletable_column
+
+        self.soft_deletable_column = options[:column] || :deleted_at
+        default_scope { where(self.quoted_table_name + ".#{soft_deletable_column} = 0") }
+      end
+
+      def soft_deletable?
+        false
+      end
+    end
+  end
+end

data/lib/rails_soft_deletable/rails/railtie.rb

@@ -0,0 +1,12 @@
+require "rails/railtie"
+require "rails_soft_deletable/rails/active_record"
+
+module RailsSoftDeletable
+  class Railtie < Rails::Railtie
+    initializer "rails_soft_deletable.initialize" do |app|
+      ActiveSupport.on_load(:active_record) do
+        include(RailsSoftDeletable::ActiveRecord)
+      end
+    end
+  end
+end

data/lib/rails_soft_deletable/version.rb

@@ -1,3 +1,3 @@
 module RailsSoftDeletable
-  VERSION = "0.0.5"
+  VERSION = "0.0.7"
 end

data/spec/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.