soft_deletable_petit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c1f687ed5886b497ff04fad86edb25059cb6d6fd
+  data.tar.gz: f9cd2ea9ad144190ac77b96a137ac1af13657f66
+SHA512:
+  metadata.gz: ac9fe027b8a6af9afa64688bc9517cf3863ccd912aea831df843089d1bbcbc4c630d1f9722f92bdec9dd3d1d419b68c26566b9938361feb35fb43a181cb98d79
+  data.tar.gz: 402a1552506b23d4dd9ac749b97c8b3d74fb5ec24ecf3d4fd891d980f55b9112d34383d29b907e4f1d3d0d93bab23f58ce1bef07f2b2b156d7e1c340782f4249

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/bundle

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.4
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/README.md

@@ -0,0 +1,83 @@
+# SoftDeletablePetit
+
+Based on [kakurenbo-puti](https://github.com/alfa-jpn/kakurenbo-puti).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'soft_deletable_petit'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install soft_deletable_petit
+
+## Usage
+
+Add `deleted_at` column to your model.
+
+and
+```ruby
+class YourModel < ActiveRecord::Base
+  soft_deletable
+end
+```
+
+### Methods
+```ruby
+m.destroy_softly # or destroy_softly!
+m.deleted? # => true
+
+m.restore # or m.restore!
+m.living? # => true
+```
+
+### Scopes
+```ruby
+YourModel.living
+YourModel.deleted
+```
+
+## Configuration
+
+In model
+
+```ruby
+class YourModel < ActiveRecord::Base
+  soft_deletable \
+    column:                     :deleted_at,
+    soft_delete_method_name:    :destroy_softly,
+    restore_method_name:        :restore,
+    soft_deleted_scope:         :deleted,
+    without_soft_deleted_scope: :living
+end
+```
+
+and you can change default configuration with `SoftDeletablePetit.configure`.
+
+```ruby
+# config/initializers/soft_deletable_petit.rb
+SoftDeletablePetit.configure do |config|
+  config.column                     = :deleted_at
+  config.soft_delete_method_name    = :destroy_softly
+  config.restore_method_name        = :restore
+  config.soft_deleted_scope         = :deleted
+  config.without_soft_deleted_scope = :living
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/soft_deletable_petit.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "soft_deletable_petit"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/soft_deletable_petit.rb

@@ -0,0 +1,5 @@
+require "soft_deletable_petit/version"
+require "soft_deletable_petit/soft_deletable"
+require 'active_record'
+
+ActiveRecord::Base.send :extend, SoftDeletablePetit::SoftDeletable

data/lib/soft_deletable_petit/builder.rb

@@ -0,0 +1,68 @@
+require "soft_deletable_petit/config"
+
+module SoftDeletablePetit
+  class Builder
+    attr_reader :klass, :options
+
+    def self.build(klass, options = {})
+      new(klass, options).build
+    end
+
+    def initialize(klass, options = {})
+      @klass = klass
+      @options = options
+    end
+
+    def build
+      define_column_name_accessor(options.column)
+
+      define_instance_methods(options.soft_delete_method_name, options.restore_method_name)
+      define_scopes(options.soft_deleted_scope, options.without_soft_deleted_scope)
+    end
+
+    private
+
+    def define_column_name_accessor(col)
+      klass.class_eval do
+        define_singleton_method(:soft_delete_column){ col }
+        define_method(:soft_delete_column){ col }
+      end
+    end
+
+    def define_instance_methods(soft_delete_method_name, restore_method_name)
+      klass.class_eval do
+        define_model_callbacks soft_delete_method_name
+        define_model_callbacks restore_method_name
+
+        define_method "#{soft_delete_method_name}!" do
+          run_callbacks(soft_delete_method_name) { touch soft_delete_column; self }
+        end
+        define_method soft_delete_method_name do
+          !! send("#{soft_delete_method_name}!") rescue false
+        end
+
+        define_method "#{restore_method_name}!" do
+          run_callbacks(restore_method_name) { update_column soft_delete_column, nil; self  }
+        end
+        define_method restore_method_name do
+          !! send("#{restore_method_name}!") rescue false
+        end
+      end
+    end
+
+    def define_scopes(soft_deleted_scope, without_soft_deleted_scope)
+      klass.class_eval do
+        scope soft_deleted_scope, ->{ where.not(soft_delete_column => nil) }
+        scope without_soft_deleted_scope, ->{ where(soft_delete_column => nil) }
+
+        define_method "#{soft_deleted_scope}?" do
+          send("#{soft_delete_column}?")
+        end
+
+        define_method "#{without_soft_deleted_scope}?" do
+          !send("#{soft_delete_column}?")
+        end
+      end
+    end
+  end
+end

data/lib/soft_deletable_petit/config.rb

@@ -0,0 +1,30 @@
+require 'active_support/configurable'
+require 'active_support/core_ext/hash/slice'
+
+module SoftDeletablePetit
+  def self.configure(&block)
+    yield config
+  end
+
+  def self.config
+    @config ||= Configuration.new
+  end
+
+  class Configuration
+    include ActiveSupport::Configurable
+
+    config_accessor :column                     do :deleted_at end
+    config_accessor :soft_delete_method_name    do :destroy_softly end
+    config_accessor :restore_method_name        do :restore end
+    config_accessor :soft_deleted_scope         do :deleted end
+    config_accessor :without_soft_deleted_scope do :living end
+
+    def config
+      self.class.config
+    end
+
+    def merge(options)
+      config.merge(options.slice(*config.keys))
+    end
+  end
+end

data/lib/soft_deletable_petit/soft_deletable.rb

@@ -0,0 +1,11 @@
+require "soft_deletable_petit/config"
+require "soft_deletable_petit/builder"
+
+module SoftDeletablePetit
+  module SoftDeletable
+    def soft_deletable(options = {})
+      @_soft_deletable_options = SoftDeletablePetit.config.merge(options)
+      SoftDeletablePetit::Builder.build(self, @_soft_deletable_options)
+    end
+  end
+end

data/lib/soft_deletable_petit/version.rb

@@ -0,0 +1,3 @@
+module SoftDeletablePetit
+  VERSION = "0.1.0"
+end

data/soft_deletable_petit.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'soft_deletable_petit/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "soft_deletable_petit"
+  spec.version       = SoftDeletablePetit::VERSION
+  spec.authors       = ["ichi"]
+  spec.email         = ["ichi.ttht.1@gmail.com"]
+
+  spec.summary       = %q{Soft Deletable for ActiveRecord.}
+  spec.description   = %q{Soft Deletable for ActiveRecord.}
+  spec.homepage      = "https://github.com/ichi/soft_deletable_petit"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activerecord", "~> 4.2"
+  spec.add_dependency "activesupport", "~> 4.2"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-its"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: soft_deletable_petit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ichi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  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: sqlite3
+  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: pry
+  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'
+description: Soft Deletable for ActiveRecord.
+email:
+- ichi.ttht.1@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/soft_deletable_petit.rb
+- lib/soft_deletable_petit/builder.rb
+- lib/soft_deletable_petit/config.rb
+- lib/soft_deletable_petit/soft_deletable.rb
+- lib/soft_deletable_petit/version.rb
+- soft_deletable_petit.gemspec
+homepage: https://github.com/ichi/soft_deletable_petit
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Soft Deletable for ActiveRecord.
+test_files: []