action-draft 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5b73826fe9719191f155c5e59f291f250baf2180c1c690d801dfccd82d9960f6
+  data.tar.gz: 29d365a7dfbfb663474e68d096437de5b5d30df26eab7a29e7fe150ba0f10186
+SHA512:
+  metadata.gz: c348a4e420d9ecc51d9eb201188e0c7f2ba67e1c95872877f45a8d1fe26ae9287e9fcf4c841964eb6da184ec1a43463a413d0e27a152b1e8d0f66430e12348c6
+  data.tar.gz: 914c21a224f2ba53a37786a18820580b9b67b207a2c1a6cdf9d07d8f94f8addf8f9c79489e49aed4a0237df3294957e109766f694a591b56df44acaf17bec83c

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+0.1.0
+-----
+
+First commit.

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Jason Lee
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,72 @@
+# Action Draft
+
+Action Draft brings your ActiveRecord model to storage multiple draft attributes without add any columns to table.
+
+[![Gem Version](https://badge.fury.io/rb/action-draft.svg)](https://rubygems.org/gems/action-draft) [![Build Status](https://travis-ci.org/rails-engine/action-draft.svg?branch=master)](https://travis-ci.org/rails-engine/action-draft)
+
+## Installation
+
+```ruby
+gem "action-draft"
+```
+
+And then execute:
+```bash
+$ bundle
+$ rails action_draft:install
+```
+
+## Usage
+
+In your ActiveRecord model:
+
+```rb
+# app/models/message.rb
+class Message < ApplicationRecord
+  has_draft :title, :content
+end
+```
+
+Now you have `draft_title`, `draft_content` attributes.
+
+Then refer to this field in the form for the model:
+
+```erb
+<%# app/views/messages/_form.html.erb %>
+<%= form_with(model: message) do |form| %>
+  …
+  <div class="field">
+    <%= form.label :draft_title %>
+    <%= form.textarea :draft_title %>
+  </div>
+
+  <div class="field">
+    <%= form.label :draft_content %>
+    <%= form.textarea :draft_content %>
+  </div>
+  …
+<% end %>
+```
+
+Save draft attributes:
+
+```rb
+irb> message = Message.new
+irb> message.draft_title = "Draft title"
+irb> message.draft_title.to_s
+"Draft title"
+irb> message.draft_content = "Draft message content"
+irb> message.draft_content.to_s
+"Draft message content"
+irb> message.save
+
+ir> message.reload
+irb> message.draft_title.to_s
+"Draft title"
+irb> message.draft_content.to_s
+"Draft message content"
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/models/action_draft/application_record.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ActionDraft
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/action_draft/content.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class ActionDraft::Content < ApplicationRecord
+  self.table_name = "action_draft_contents"
+
+  belongs_to :record, polymorphic: true, touch: true
+
+  delegate :to_s, :nil?, :blank?, :present?, to: :content
+end

data/config/routes.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+ActionDraft::Engine.routes.draw do
+  resources :drafts
+end

data/db/migrate/20190724102032_create_action_draft_contents.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class CreateActionDraftContents < ActiveRecord::Migration[6.0]
+  def change
+    create_table :action_draft_contents do |t|
+      t.references :record, null: false, polymorphic: true, index: false
+      t.string :name
+      t.text :content, limit: 16777215
+
+      t.timestamps
+
+      t.index [ :record_type, :record_id, :name ], name: "index_action_drafts_uniqueness", unique: true
+    end
+  end
+end

data/lib/action-draft.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "action-draft/version"
+require "action-draft/attribute"
+require "action-draft/engine"
+
+module ActionDraft
+  # Your code goes here...
+end

data/lib/action-draft/attribute.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module ActionDraft
+  module Attribute
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :__action_draft_names
+    end
+
+    class_methods do
+      # Provides access to a dependent ActionDraft::Content model that holds the draft attributes.
+      # This dependent attribute is lazily instantiated and will be auto-saved when it's been changed. Example:
+      #
+      #   class Message < ActiveRecord::Base
+      #     has_draft :title, :content
+      #   end
+      #
+      #   message = Message.create!(draft_title: "This is draft title", draft_content: "<h1>Funny times!</h1>")
+      #   message.draft_title # => "This is draft title"
+      #   message.draft_content # => "<h1>Funny times!</h1>"
+      #
+      # If you wish to preload the dependent ActionDraft::Content model, you can use the named scope:
+      #
+      #   Message.all.with_draft_title # Avoids N+1 queries when you just want the draft fields.
+      def has_draft(*names)
+        __action_draft_names ||= []
+        names = Array(names)
+        names.each do |name|
+          __action_draft_names << name
+
+          class_eval <<-CODE, __FILE__, __LINE__ + 1
+            def draft_#{name}
+              self.draft_#{name}_content ||= ActionDraft::Content.new(name: "#{name}", record: self)
+            end
+
+            def draft_#{name}=(content)
+              self.draft_#{name}.content = content
+            end
+          CODE
+
+          has_one :"draft_#{name}_content", -> { where(name: name) }, class_name: "ActionDraft::Content", as: :record, inverse_of: :record, dependent: :destroy
+        end
+
+        scope :with_drafts, -> do
+          names = __action_draft_names.map { |name| "draft_#{name}_content" }
+          includes(*names)
+        end
+
+        after_save do
+          __action_draft_names.each do |name|
+            public_send("draft_#{name}").save if public_send("draft_#{name}").changed?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/action-draft/engine.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ActionDraft
+  class Engine < ::Rails::Engine
+    isolate_namespace ActionDraft
+    config.eager_load_namespaces << ActionDraft
+
+    initializer "action_draft.attribute" do
+      ActiveSupport.on_load(:active_record) do
+        include ActionDraft::Attribute
+      end
+    end
+  end
+end

data/lib/action-draft/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ActionDraft
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: action-draft
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jason Lee
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-07-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: pg
+  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: Help your ActiveRecord model to storage draft field.
+email:
+- huacnlee@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- MIT-LICENSE
+- README.md
+- app/models/action_draft/application_record.rb
+- app/models/action_draft/content.rb
+- config/routes.rb
+- db/migrate/20190724102032_create_action_draft_contents.rb
+- lib/action-draft.rb
+- lib/action-draft/attribute.rb
+- lib/action-draft/engine.rb
+- lib/action-draft/version.rb
+homepage: http://github.com/rails-engine/action-draft
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Help your ActiveRecord model to storage draft field.
+test_files: []