nice_form 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 72f4c95c9bf001b15641096f7319debd084001453ec44d2d2f542364fc2b49c2
+  data.tar.gz: f5a2b2e1c06c38ed2021e0c4a3291294aa25e985b4be7b7a2efff855ab33a0c0
+SHA512:
+  metadata.gz: 35428d57f07eca576a171a9fdc8ab2c819de10da76ac60f81f028ff88c0debb5b439319ad0cdd2cbebd3d9a90ef8f9508c2f3df9600403112a70a5683030fa1e
+  data.tar.gz: 36c61bcb52645737f4f1043dae8f9efdea5bbc8a9b5aa9e057ffc03fd9b03f015548a7262f6659f7fe78adabb4b5d02e1a98dbb5b25ee6832707ccffce3a3d79

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-05-20
+
+- Initial release

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "rubocop", "~> 1.21"

data/README.md

@@ -0,0 +1,179 @@
+# NiceForm
+
+A nice form object for Rails that makes sense.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add nice_form
+
+You might want to create an application-wide form:
+
+```ruby
+class ApplicationForm < NiceForm::Base; end
+```
+
+Or configure the default primary key settings if you're using something other than `id`:
+
+```ruby
+NiceForm.configure do |config|
+  #                     name,  type 
+  config.primary_key = [:uuid, :string]
+end
+```
+
+You can also set this on a form-by-form basis.
+
+## Usage
+
+It's just like Active Model, but with some nice-to-haves.
+
+### Basic usage 
+
+Treat it like an Active Model object:
+
+```ruby
+class PostForm < NiceForm::Base
+  self.acts_like = :post 
+  
+  attribute :subject
+  attribute :context, :text
+  attribute :published_at, :datetime
+  attribute :requires_review, :boolean
+end
+```
+
+```ruby
+class PostsController < ApplicationController
+  def new
+    @form = PostForm.new 
+  end
+end
+```
+
+### From params
+
+```ruby
+class PostsController < ApplicationController
+  def create
+    @form = PostForm.new(post_params)
+  end
+  
+  private 
+  
+  def post_params
+    params.require(:post).permit(:subject, :content, :published_at, :requires_review)
+  end
+end
+```
+
+### From a model
+
+```ruby
+class PostsController < ApplicationController
+  def edit
+    post = Post.find(params[:id])
+    @form = PostForm.from_model(post) # { id: 1, subject: "hello" ... }
+  end
+end
+```
+
+#### Map additional attributes to a form object
+
+```ruby
+class PostsController < ApplicationController
+  def edit
+    post = Post.find(params[:id])
+    @form = PostForm.from_model(post)
+  end
+end
+```
+
+```ruby
+class PostForm < NiceForm::Base
+  self.acts_like = :post 
+  
+  attribute :subject
+  attribute :context, :text
+  attribute :published_at, :datetime
+  attribute :requires_review, :boolean
+  
+  def map_model(model)
+    model.requires_review = model.reviews.last.status == 'review'
+  end
+end
+```
+
+### Change the param key
+
+```ruby
+Rails.application.routes.draw do 
+  resources :posts, param_name: :uuid
+end
+```
+
+```ruby
+class PostsController < ApplicationController
+  def edit
+    post = Post.find(params[:uuid])
+    @form = PostForm.from_model(post)
+  end
+end
+```
+
+```ruby
+class PostForm < NiceForm::Base
+  self.acts_like = :post 
+  
+  self.primary_key :uuid, :string
+  
+  # ... 
+end
+```
+
+## Validations
+
+Again, just like an Active Model object:
+
+```ruby
+class PostForm < NiceForm::Base
+  self.acts_like = :post 
+  
+  attribute :subject
+  
+  validates :subject, presence: true 
+end
+```
+
+## External context
+
+```ruby
+class PostsController < ApplicationController
+  def new
+    @form = PostForm.new.with_context(user: current_staff_user)
+  end
+end
+```
+
+```ruby
+class PostForm < NiceForm::Base
+  self.acts_like = :post 
+  
+  attribute :category_id, :integer
+  attribute :subject
+  attribute :context, :text
+  attribute :published_at, :datetime
+  
+  validates :category_id, with: :ensure_category_id!
+  
+  private 
+  
+  def ensure_category_id!
+    unless CategoryUser.where(category_id: category_id, user: context[:user]).exists?
+      self.errors.add(:category_id, "is invalid")
+      throw(:abort)
+    end
+  end
+end
+```

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/nice_form/acts_like.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module NiceForm
+  # Allows you to define the model name of the form
+  #
+  #   class CatForm < NiceForm::Base
+  #     self.acts_like = :cat
+  #   end
+  #
+  # Automatically infers the name if not set.
+  module ActsLike
+    def self.included(klass)
+      klass.extend ClassMethods
+    end
+
+    module ClassMethods
+      def acts_like=(val)
+        @acts_like_model = val.to_s.underscore.to_sym
+      end
+
+      def acts_like_model_name
+        @acts_like_model || inferred_model_name
+      end
+
+      def inferred_model_name
+        class_name = name.demodulize
+        return :form if class_name == "Form"
+
+        class_name.delete_suffix("Form").underscore.to_sym
+      end
+
+      def model_name
+        ActiveModel::Name.new(self, nil, acts_like_model_name.to_s.camelize)
+      end
+    end
+  end
+end

data/lib/nice_form/base.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+require 'active_model'
+
+require_relative "instantiation"
+require_relative "acts_like"
+require_relative "primary_key"
+
+module NiceForm
+  class Base
+    extend ActiveModel::Naming
+    extend ActiveModel::Translation
+
+    include ActiveModel::Attributes
+    include ActiveModel::AttributeAssignment
+    include ActiveModel::Callbacks
+    include ActiveModel::Conversion
+    include ActiveModel::Validations
+
+    include ActsLike
+    include Instantiation
+    include PrimaryKey
+
+    define_model_callbacks :validation, only: :before
+
+    attr_reader :context
+
+    def self.inherited(klass)
+      super
+      klass.primary_key(*NiceForm.config.primary_key)
+    end
+
+    def initialize(attributes = {})
+      assign_attributes(attributes) if attributes
+      super()
+    end
+
+    def self.inspect
+      attr_list = attribute_types.map { |name, type| "#{name}: #{type.type}" } * ", "
+      "#{self.name}(#{attr_list})"
+    end
+
+    def inspect
+      inspection = if defined?(@attributes) && @attributes
+                     self.class.attribute_names.filter_map do |name|
+                       "#{name}: #{attribute_for_inspect(name)}" if _has_attribute?(name)
+                     end.join(", ")
+                   else
+                     "not initialized"
+                   end
+
+      "#<#{self.class} #{inspection}>"
+    end
+
+    def attributes
+      attrs = [self.class.form_primary_key]
+
+      attrs << if ::NiceForm.config.primary_key.is_a?(Array)
+                 ::NiceForm.config.primary_key[0].to_s
+               else
+                 ::NiceForm::Config.primary_key.to_s
+               end
+
+      super.except(*attrs)
+    end
+
+    def to_model
+      self
+    end
+
+    def to_param
+      attribute(self.class.form_primary_key)
+    end
+
+    def to_key
+      key = attribute(self.class.form_primary_key)
+      return nil if key.nil?
+
+      [key]
+    end
+
+    def persisted?
+      to_param.present?
+    end
+
+    def with_context(attrs = {})
+      @context = attrs
+    end
+
+    private
+
+    def format_for_inspect(value)
+      if value.nil?
+        value.inspect
+      elsif value.is_a?(String) && value.length > 50
+        "#{value[0, 50]}...".inspect
+      elsif value.is_a?(Date) || value.is_a?(Time)
+        %("#{value.to_fs(:inspect)}")
+      else
+        value.inspect
+      end
+    end
+
+    def attribute_for_inspect(attr_name)
+      attr_name = attr_name.to_s
+      attr_name = self.class.attribute_aliases[attr_name] || attr_name
+      value = _read_attribute(attr_name)
+      format_for_inspect(value)
+    end
+
+    def _has_attribute?(attr_name)
+      @attributes.key?(attr_name)
+    end
+  end
+end

data/lib/nice_form/config.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module NiceForm
+  class Configuration
+    attr_accessor :primary_key
+
+    def initialize
+      @primary_key = %i[id integer]
+    end
+
+    def primary_key=(val)
+      @primary_key = if val.is_a?(Array)
+                       val
+                     else
+                       [val, :integer]
+                     end
+    end
+  end
+
+  def self.configure
+    yield config
+  end
+
+  def self.config
+    @config ||= Configuration.new
+  end
+end

data/lib/nice_form/instantiation.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module NiceForm
+  module Instantiation
+    def self.included(klass)
+      klass.include FromParams
+      klass.include FromHash
+      klass.include FromModel
+      klass.include FromJson
+    end
+
+    module FromHash
+      def self.included(klass)
+        klass.extend ClassMethods
+      end
+
+      module ClassMethods
+        def from_hash(hash)
+          from_params(hash)
+        end
+      end
+    end
+
+    module FromParams
+      def self.included(klass)
+        klass.extend ClassMethods
+      end
+
+      module ClassMethods
+        def from_params(params, additional_params = {})
+          instance = new
+          instance.assign_attributes(params.merge(additional_params))
+          instance
+        end
+      end
+    end
+
+    module FromModel
+      def self.included(klass)
+        klass.extend ClassMethods
+      end
+
+      module ClassMethods
+        def from_model(model)
+          instance = new
+          instance.class.attribute_names.each do |attr|
+            instance.public_send("#{attr}=", model.public_send(attr)) if model.respond_to?(attr)
+          end
+          instance.map_model(model)
+          instance
+        end
+      end
+
+      # assign attributes to self
+      def map_model(model); end
+    end
+
+    module FromJson
+      def self.included(klass)
+        klass.extend ClassMethods
+      end
+
+      module ClassMethods
+        def from_json(string)
+          from_params(JSON.parse(string))
+        end
+      end
+    end
+  end
+end

data/lib/nice_form/primary_key.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module NiceForm
+  module PrimaryKey
+    def self.included(klass)
+      klass.extend ClassMethods
+    end
+
+    module ClassMethods
+      def primary_key(name, type = :integer)
+        if name.is_a?(Array)
+          type = name[1]
+          name = name[0]
+        end
+        undefine_primary_key(form_primary_key)
+        define_primary_key(name, type)
+      end
+
+      def form_primary_key
+        @form_primary_key ||= define_primary_key(NiceForm.config.primary_key[0], NiceForm.config.primary_key[1])
+      end
+
+      def undefine_primary_key(name)
+        if attribute_names.include?(name.to_s)
+          undef_method(name.to_s) if respond_to?(name.to_s)
+          undef_method("#{name}=") if respond_to?("#{name}=")
+          attribute_types.delete(name.to_s)
+          _default_attributes.send(:attributes).delete(name.to_s)
+        end
+      end
+
+      def define_primary_key(name, type = :integer)
+        attribute name, type
+        @form_primary_key = name.to_s
+      end
+    end
+  end
+end

data/lib/nice_form/version.rb

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

data/lib/nice_form.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+require "active_support/concern"
+
+require_relative "nice_form/version"
+require_relative "nice_form/config"
+require_relative "nice_form/base"
+
+module NiceForm
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: nice_form
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Partytray
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-05-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !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: A form object.
+email:
+- 97254326+Partytray@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- lib/nice_form.rb
+- lib/nice_form/acts_like.rb
+- lib/nice_form/base.rb
+- lib/nice_form/config.rb
+- lib/nice_form/instantiation.rb
+- lib/nice_form/primary_key.rb
+- lib/nice_form/version.rb
+homepage: https://github.com/partytray/nice_form
+licenses: []
+metadata:
+  homepage_uri: https://github.com/partytray/nice_form
+  source_code_uri: https://github.com/partytray/nice_form
+  changelog_uri: https://github.com/partytray/nice_form
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.11
+signing_key:
+specification_version: 4
+summary: A form object.
+test_files: []