prefab-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 36fa92e24129e08b97863e761ca264ae7f9b66201b88e993b202b2c6dc518da6
+  data.tar.gz: ddad80be43e110f1450a81dcd32cadf193d7f8dbad72d92bfba8c015ad4fc252
+SHA512:
+  metadata.gz: aa933651fbe518479f1a5705b1d5e5c8203eee791dd9dbcb3b733b3f2d6c5798f8eab4aac0d36e0667149200b263fbafedd161588343f3d59a6c57b3c0656002
+  data.tar.gz: 40de439031905a366add2b3167d4f55e40101fe1230319f689b36e8d8b364932eba603a6d795b7bc1307cda4281a63a88b0f1f86a1655689c38368e18e545399

data/.rspec

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

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 2.6

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in prefab.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "standard", "~> 1.3"

data/Gemfile.lock

@@ -0,0 +1,126 @@
+PATH
+  remote: .
+  specs:
+    prefab (0.1.0)
+      actionpack
+      activesupport
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (7.0.5)
+      actionview (= 7.0.5)
+      activesupport (= 7.0.5)
+      rack (~> 2.0, >= 2.2.4)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (7.0.5)
+      activesupport (= 7.0.5)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activesupport (7.0.5)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    builder (3.2.4)
+    concurrent-ruby (1.2.2)
+    crass (1.0.6)
+    diff-lcs (1.5.0)
+    erubi (1.12.0)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    json (2.6.3)
+    language_server-protocol (3.17.0.2)
+    loofah (2.21.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    method_source (1.0.0)
+    minitest (5.18.1)
+    nokogiri (1.15.2-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.15.2-x86_64-linux)
+      racc (~> 1.4)
+    parallel (1.22.1)
+    parser (3.2.0.0)
+      ast (~> 2.4.1)
+    racc (1.7.1)
+    rack (2.2.7)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    railties (7.0.5)
+      actionpack (= 7.0.5)
+      activesupport (= 7.0.5)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+      zeitwerk (~> 2.5)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.0)
+    rexml (3.2.5)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-rails (6.0.3)
+      actionpack (>= 6.1)
+      activesupport (>= 6.1)
+      railties (>= 6.1)
+      rspec-core (~> 3.12)
+      rspec-expectations (~> 3.12)
+      rspec-mocks (~> 3.12)
+      rspec-support (~> 3.12)
+    rspec-support (3.12.0)
+    rubocop (1.42.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.24.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.24.1)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.15.2)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    standard (1.22.0)
+      language_server-protocol (~> 3.17.0.2)
+      rubocop (= 1.42.0)
+      rubocop-performance (= 1.15.2)
+    thor (1.2.2)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.4.2)
+    zeitwerk (2.6.8)
+
+PLATFORMS
+  arm64-darwin-22
+  x86_64-linux
+
+DEPENDENCIES
+  prefab!
+  rake (~> 13.0)
+  rspec-rails
+  standard (~> 1.3)
+
+BUNDLED WITH
+   2.4.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Bradly Feeley
+
+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,42 @@
+# Prefab
+
+A lightweight library for managing resources in your Rails application's controllers
+
+## Introduction
+
+This gem provides a lightweight library that simplifies the controllers of your resources in a Rails application. It offers a set of intuitive and convenient methods for handling common CRUD operations, including creating, reading, updating, and deleting resources.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add prefab
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install prefab
+
+## Usage
+Include Prefab::Base in your top-level controller.
+
+```ruby
+class ApplicationController < ActionController::Base
+  include Prefab::Base
+end
+```
+
+That will give your other controllers access to the prefab class method. Then you can prefab your specific resources:
+
+```ruby
+class PostsController < ApplicationController
+  prefab :posts
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bradly/prefab.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/lib/prefab/base.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Prefab
+  module Base
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def prefab(resource_name, parent: nil, permitted_params: nil)
+        include Prefab::Controller
+
+        @resource_name    = resource_name.to_s.singularize
+        @parent_name      = parent&.to_s&.singularize
+        @permitted_params = permitted_params
+      end
+    end
+  end
+end

data/lib/prefab/controller.rb

@@ -0,0 +1,112 @@
+module Prefab::Controller
+  extend ActiveSupport::Concern
+
+  included do
+    before_action :collection, only: :index
+    before_action :resource,   only: [:show, :new, :create, :edit, :update, :destroy]
+    before_action :parent
+  end
+
+  def index; end
+  def  show; end
+  def   new; end
+  def  edit; end
+
+  def create
+    if resource.save
+      redirect_to resource, notice: save_success_message
+    else
+      render :new, alert: save_failed_message
+    end
+  end
+
+  def update
+    if resource.update(resource_params)
+      redirect_to resource, notice: save_success_message
+    else
+      render :edit, alert: save_failed_message
+    end
+  end
+
+  def destroy
+    resource.destroy!
+    redirect_back(fallback_location: root_path)
+  end
+
+  private
+
+  def resource_name
+    self.class.instance_variable_get(:"@resource_name")
+  end
+
+  def parent_name
+    self.class.instance_variable_get(:"@parent_name")
+  end
+
+  def permitted_params
+    self.class.instance_variable_get(:"@permitted_params")
+  end
+
+  def collection_name
+    resource_name.pluralize
+  end
+
+  def collection
+    @collection ||= instance_variable_set("@#{collection_name}", resource_scope.all)
+  end
+
+  def parent_class
+    @parent_class ||= parent_name.to_s.camelize.constantize
+  end
+
+  def parent
+    return unless has_parent?
+
+    @parent ||= begin
+      @parent = parent_class.find(params["#{parent_name}_id"])
+      instance_variable_set("@#{parent_name}", @parent)
+      @parent
+    end
+  end
+
+  def has_parent?
+    parent_name.present?
+  end
+
+  def resource_scope
+    if has_parent?
+      parent.public_send(resource_name.pluralize)
+    else
+      resource_name.to_s.camelize.constantize
+    end
+  end
+
+  def resource
+    @resource ||= begin
+      @resource = case action_name
+                  when 'new'
+                    resource_scope.new
+                  when 'create'
+                    resource_scope.new(resource_params)
+                  else
+                    resource_scope.find(params[:id])
+                  end
+
+      instance_variable_set("@#{resource_name}", @resource)
+
+      @resource
+    end
+  end
+
+  def resource_params
+    params.require(resource_name).permit(*permitted_params)
+  end
+
+  def save_success_message
+    "#{resource_name} saved"
+  end
+
+  def save_failed_message
+    "There was a problem saving this #{resource_name}"
+  end
+end

data/lib/prefab/version.rb

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

data/lib/prefab.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'active_support'
+
+require_relative "prefab/version"
+require_relative "prefab/controller"
+require_relative "prefab/base"
+
+module Prefab
+end

data/sig/prefab.rbs

@@ -0,0 +1,4 @@
+module Prefab
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: prefab-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bradly Feeley
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-06-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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: This gem provides a lightweight library that simplifies the controllers
+  of your resources in a Rails application. It offers a set of intuitive and convenient
+  methods for handling common CRUD operations, including creating, reading, updating,
+  and deleting resources.
+email:
+- 4227+bradly@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".standard.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/prefab.rb
+- lib/prefab/base.rb
+- lib/prefab/controller.rb
+- lib/prefab/version.rb
+- sig/prefab.rbs
+homepage: https://github.com/bradly/prefab
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/bradly/prefab
+  source_code_uri: https://github.com/bradly/prefab
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.6
+signing_key:
+specification_version: 4
+summary: A lightweight library for managing resources in your Rails application's
+  controllers
+test_files: []