stateful_field_for 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 00e7a7cbc4bee02957da2fa1a4f4d898747a6aad
+  data.tar.gz: f760d30c688490fbd49db1be2d16f792cb084ccc
+SHA512:
+  metadata.gz: e33b5b26affe43e1b4cac65ff6ef010f7fa6459c46ed8cbbf88e37b8ade7809063293245e49d1627da80cbf2d327164768a22435cb26a3ed80af490b9e2f1a92
+  data.tar.gz: 5fbd107d095b9a6122d8e3a38d2ea37a6c5ff0dcfed1cf4e5542cb49dc7851caedd8ea9cfc2b29e2ceaa2980c07cb113aa297c2fd1793548361d3f5c610c01b3

data/README.md

@@ -0,0 +1,50 @@
+# StatefulFieldFor
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+
+Provide the bang and predicate methods for Active Record.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "stateful_field_for"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install stateful_field_for
+
+## Usage
+
+```diff
+class Picture < ApplicationRecord
++  stateful_field_for :hidden_at, scope: true do
++    enable  :hide, to: :hidden
++    disable :show, to: :visible, initial: true
++  end
+end
+```
+
+Then you can use the bang and predicate methods:
+
+```ruby
+picture = Picture.create
+
+picture.show!
+picture.hidden?  # false
+picture.visible? # true
+
+picture.hide!
+picture.hidden?  # true
+picture.visible? # false
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

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

data/lib/stateful_field_for.rb

@@ -0,0 +1,13 @@
+require "stateful_field_for/version"
+
+module StatefulFieldFor
+  def stateful_field_for(attr_name, options = {}, &block)
+    definition = Definition.new(attr_name, options)
+    definition.instance_eval(&block)
+    const_set definition.module_name, definition._module
+    include definition._module
+  end
+end
+
+require "stateful_field_for/definition"
+require "stateful_field_for/railtie" if defined?(Rails)

data/lib/stateful_field_for/definition.rb

@@ -0,0 +1,97 @@
+module StatefulFieldFor
+  class Definition
+    attr_reader :attr_name, :prefix, :suffix, :scope, :logic
+
+    def initialize(attr_name, options = {})
+      @attr_name = attr_name
+      @prefix    = options[:prefix]
+      @suffix    = options[:suffix]
+      @scope     = options[:scope] || false
+      @logic     = (options[:type] == :date) ? "Date.today" : "Time.current"
+    end
+
+    def _module
+      @_module ||= Module.new do
+        def self.included(klass)
+          __define_scope_for_activate(klass)   if respond_to?(:__define_scope_for_activate)
+          __define_scope_for_deactivate(klass) if respond_to?(:__define_scope_for_deactivate)
+          __define_after_initialize(klass)     if respond_to?(:__define_after_initialize)
+        end
+      end
+    end
+
+    def module_name
+      "generated_#{attr_name}_stateful_methods".split("_").map(&:camelize).join
+    end
+
+    private
+
+      def enable(event_basename, to: nil, initial: false)
+        event = format_name(event_basename)
+        state = to.nil? ? event : format_name(to)
+
+        _module.module_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def #{state}?
+            !#{attr_name}.nil?
+          end
+
+          def #{event}
+            self.#{attr_name} = #{logic}
+          end
+
+          def #{event}!(options = {})
+            #{event}
+            save!(options)
+          end
+        RUBY
+
+        _module.module_eval <<-RUBY, __FILE__, __LINE__ + 1 if scope
+          def self.__define_scope_for_activate(klass)
+            klass.scope :#{state}, -> { where.not(#{attr_name}: nil) }
+          end
+        RUBY
+
+        _module.module_eval <<-RUBY, __FILE__, __LINE__ + 1 if initial
+          def self.__define_after_initialize(klass)
+            klass.after_initialize :#{event}
+          end
+        RUBY
+      end
+
+      def disable(event_basename, to: nil, initial: false)
+        event = format_name(event_basename)
+        state = to.nil? ? event : format_name(to)
+
+        _module.module_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def #{state}?
+            #{attr_name}.nil?
+          end
+
+          def #{event}
+            self.#{attr_name} = nil
+          end
+
+          def #{event}!(options = {})
+            #{event}
+            save!(options)
+          end
+        RUBY
+
+        _module.module_eval <<-RUBY, __FILE__, __LINE__ + 1 if scope
+          def self.__define_scope_for_deactivate(klass)
+            klass.scope :#{state}, -> { where(#{attr_name}: nil) }
+          end
+        RUBY
+
+        _module.module_eval <<-RUBY, __FILE__, __LINE__ + 1 if initial
+          def self.__define_after_initialize(klass)
+            klass.after_initialize :#{event}
+          end
+        RUBY
+      end
+
+      def format_name(basename)
+        [prefix, basename, suffix].compact.join("_")
+      end
+  end
+end

data/lib/stateful_field_for/railtie.rb

@@ -0,0 +1,9 @@
+module StatefulFieldFor
+  class Railtie < ::Rails::Railtie
+    initializer :stateful_field_for do
+      ActiveSupport.on_load :active_record do
+        extend StatefulFieldFor
+      end
+    end
+  end
+end

data/lib/stateful_field_for/version.rb

@@ -0,0 +1,3 @@
+module StatefulFieldFor
+  VERSION = "0.1.0".freeze
+end

data/spec/fake_app/application.rb

@@ -0,0 +1,37 @@
+require "active_record"
+require "action_controller"
+require "stateful_field_for"
+
+ActiveRecord::Base.establish_connection(adapter: "sqlite3", database: ":memory:")
+
+module FakeApp
+  class Application < Rails::Application
+    config.eager_load = false
+  end
+end
+
+FakeApp::Application.initialize!
+
+class CreateTables < ActiveRecord::Migration[5.1]
+  def change
+    create_table :pictures do |t|
+      t.string :title
+      t.datetime :published_at
+      t.datetime :hidden_at
+
+      t.timestamps
+    end
+  end
+end
+
+class Picture < ActiveRecord::Base
+  stateful_field_for :published_at, scope: true do
+    enable  :publish,   to: :published, initial: true
+    disable :unpublish, to: :unpublished
+  end
+
+  stateful_field_for :hidden_at do
+    enable  :hide, to: :hidden
+    disable :show, to: :visible
+  end
+end

data/spec/fake_app/config.ru

@@ -0,0 +1 @@
+run Rails.application

data/spec/model_spec.rb

@@ -0,0 +1,85 @@
+require "spec_helper"
+
+RSpec.describe Picture do
+  context "scope" do
+    let!(:published_records) { Array.new(3) { Picture.create(published_at: Time.current) } }
+    let!(:unpublished_records) { Array.new(3) { Picture.create.tap(&:unpublish!) } }
+
+    describe ".published" do
+      subject { Picture.published.pluck(:id) }
+      it { is_expected.to match_array published_records.map(&:id) }
+    end
+
+    describe ".unpublished" do
+      subject { Picture.unpublished.pluck(:id) }
+      it { is_expected.to match_array unpublished_records.map(&:id) }
+    end
+  end
+
+  context "callback" do
+    let(:instance) { Picture.new }
+    subject { instance.published? }
+    it { is_expected.to be true }
+  end
+
+  context "predicate" do
+    let(:published) { Picture.new(published_at: Time.current) }
+    let(:unpublished) { Picture.new.tap(&:unpublish) }
+    let(:hidden) { Picture.new(hidden_at: Time.current) }
+    let(:visible) { Picture.new(hidden_at: nil) }
+
+    describe "#published?" do
+      it { expect(published.published?).to be true }
+      it { expect(unpublished.published?).to be false }
+    end
+
+    describe "#unpublished?" do
+      it { expect(unpublished.unpublished?).to be true }
+      it { expect(published.unpublished?).to be false }
+    end
+
+    describe "#hidden?" do
+      it { expect(hidden.hidden?).to be true }
+      it { expect(visible.hidden?).to be false }
+    end
+
+    describe "#visible?" do
+      it { expect(visible.visible?).to be true }
+      it { expect(hidden.visible?).to be false }
+    end
+  end
+
+  context "bang" do
+    let(:published) { Picture.new(published_at: Time.current) }
+    let(:hidden) { Picture.new(hidden_at: Time.current) }
+    let(:visible) { Picture.new(hidden_at: nil) }
+
+    describe "#publish!" do
+      let(:instance) { Picture.new(published_at: nil) }
+      before { instance.publish! }
+      it { expect(instance.published?).to be true }
+      it { expect(instance.persisted?).to be true }
+    end
+
+    describe "#unpublish!" do
+      let(:instance) { Picture.new(published_at: Time.current) }
+      before { instance.unpublish! }
+      it { expect(instance.unpublished?).to be true }
+      it { expect(instance.persisted?).to be true }
+    end
+
+    describe "#hide!" do
+      let(:instance) { Picture.new(hidden_at: nil) }
+      before { instance.hide! }
+      it { expect(instance.hidden?).to be true }
+      it { expect(instance.persisted?).to be true }
+    end
+
+    describe "#show!" do
+      let(:instance) { Picture.new(hidden_at: Time.current) }
+      before { instance.show! }
+      it { expect(instance.visible?).to be true }
+      it { expect(instance.persisted?).to be true }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+require "bundler/setup"
+# load Rails first
+require "rails"
+
+# needs to load the app next
+require_relative "fake_app/application"
+
+require "stateful_field_for"
+require "rspec/rails"
+require "pry"
+
+RSpec.configure do |config|
+  config.example_status_persistence_file_path = ".rspec_status"
+  config.disable_monkey_patching!
+  config.use_transactional_fixtures = true
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end
+
+CreateTables.migrate(:up) unless ActiveRecord::Base.connection.table_exists?("pictures")

data/spec/stateful_field_for_spec.rb

@@ -0,0 +1,7 @@
+require "spec_helper"
+
+RSpec.describe StatefulFieldFor do
+  it "has a version number" do
+    expect(StatefulFieldFor::VERSION).not_to be nil
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: stateful_field_for
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yoshiyuki Hirano
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+description: Provide the bang and predicate methods for Active Record
+email:
+- yhirano@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/stateful_field_for.rb
+- lib/stateful_field_for/definition.rb
+- lib/stateful_field_for/railtie.rb
+- lib/stateful_field_for/version.rb
+- spec/fake_app/application.rb
+- spec/fake_app/config.ru
+- spec/fake_app/log/development.log
+- spec/model_spec.rb
+- spec/spec_helper.rb
+- spec/stateful_field_for_spec.rb
+homepage: https://github.com/yhirano55/stateful_field_for
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Provide the bang and predicate methods for Active Record
+test_files:
+- spec/fake_app/application.rb
+- spec/fake_app/config.ru
+- spec/fake_app/log/development.log
+- spec/model_spec.rb
+- spec/spec_helper.rb
+- spec/stateful_field_for_spec.rb