xavius-controllers 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c3053be7fc49f0734065547ed8aa64977007d6859ab3dfcd880534a731c2bff
-  data.tar.gz: 51dbe9fb23d2f1f763240bda05862a0cdbd76c3c5f5e546f2515dfda5cb828cc
+  metadata.gz: 6e66917d0dc5a3438ba52d547fccda380b3267162686ed5d0232f459e34ea6e2
+  data.tar.gz: b3de3703f0892d241ea3423ea3dfa92e164b22404655ac2adec3e3015e457d48
 SHA512:
-  metadata.gz: 5cc6e9ef552d694846d9bf4a0de8f8abc2c04c735968c2cadfef578b0acd8e5e98678ec95b260319bc6c1c44cca7a892c79530d2097f4f97bed95e034be6d0e9
-  data.tar.gz: e0d745ad9eba541749591b35ae8ff1f7f0393f46457282576052e7ab405e92c233b91828ab79adf60c2a39f3caa16f157eddabf64102958e0c0801ef2b5a23ac
+  metadata.gz: 34656a9e906407423635ea7c7f7e635a476114dd86819dc5cc326768a3da9dd81d0128a8599e2ca507fa4e80455786a57a8197a02283b6c2436ec2c187af6c90
+  data.tar.gz: 302f0ca80e1428e333bfb87cb05e9fe9adb61541adcf24490b4d727a47b288a02171f66b4e1de1956bd057fa93e5eb050012fc2e52941538abb967fe8462c00d

data/lib/generators/xavius/action/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Easy way to create action classes so you don't get the wrong namespace
+
+Example:
+    rails generate xavius:action create posts
+
+    This will create:
+        app/actions/posts/create_action.rb

data/lib/generators/xavius/action/action_generator.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+class Xavius::ActionGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('templates', __dir__)
+  desc 'This generator creates Action classes for you'
+
+  def create_action_class
+    @action_name, @namespace = ARGV
+    template "action.rb", "app/actions/#{@namespace}/#{@action_name}_action.rb"
+  end
+end

data/lib/generators/xavius/action/templates/action.rb

@@ -0,0 +1,5 @@
+class <%= @namespace.camelize %>::<%= @action_name.camelize %>Action < Xavius::Actions::Base
+  def perform
+    raise NotImplementedError, "Your action in app/actions/<%= @namespace %>/<%= @action_name %>_action.rb must be implemented"
+  end
+end

data/lib/xavius/actions/base.rb

@@ -0,0 +1,14 @@
+require 'forwardable'
+
+module Xavius
+  module Actions
+    class Base
+      extend Forwardable
+      def_delegators :@context, :resource_class, :resource, :resource_params
+
+      def initialize(context)
+        @context = context
+      end
+    end
+  end
+end

data/lib/xavius/actions/context.rb

@@ -0,0 +1,17 @@
+module Xavius
+  module Actions
+    class Context
+      attr_reader :resource_class, :resource
+
+      def initialize(**params)
+        @resource         = params.fetch(:resource)
+        @resource_class   = @resource.class
+        @resource_params  = params.fetch(:resource_params)
+      end
+
+      def resource_params
+        @resource_params.call
+      end
+    end
+  end
+end

data/lib/xavius/actions/create.rb

@@ -0,0 +1,9 @@
+module Xavius
+  module Actions
+    class Create < Base
+      def perform
+        resource.update(resource_params)
+      end
+    end
+  end
+end

data/lib/xavius/actions/destroy.rb

@@ -0,0 +1,9 @@
+module Xavius
+  module Actions
+    class Destroy < Base
+      def perform
+        resource.destroy
+      end
+    end
+  end
+end

data/lib/xavius/actions/index.rb

@@ -0,0 +1,9 @@
+module Xavius
+  module Actions
+    class Index < Base
+      def perform
+        resource_class.all
+      end
+    end
+  end
+end

data/lib/xavius/actions/update.rb

@@ -0,0 +1,9 @@
+module Xavius
+  module Actions
+    class Update < Base
+      def perform
+        resource.update(resource_params)
+      end
+    end
+  end
+end

data/lib/xavius/controllers/base.rb

@@ -0,0 +1,63 @@
+require 'active_support/concern'
+
+module Xavius
+  module Controllers
+    module Base
+      extend ActiveSupport::Concern
+
+      included do
+        include Xavius::Controllers::Helpers
+        before_action :set_resource
+      end
+
+      def index
+        instance_variable_set(instance_variable_name_for(collection_name), perform_action)
+      end
+
+      def create
+        respond_to do |format|
+          if perform_action
+            format.html { redirect_to action_context.resource, notice: success_message }
+            format.json { render :show, status: :created, location: action_context.resource }
+          else
+            format.html { render :new }
+            format.json { render json: action_context.resource.errors, status: :unprocessable_entity }
+          end
+        end
+      end
+
+      def update
+        respond_to do |format|
+          if perform_action
+            format.html { redirect_to action_context.resource, notice: success_message }
+            format.json { render :show, status: :ok, location: action_context.resource }
+          else
+            format.html { render :edit }
+            format.json { render json: action_context.resource.errors, status: :unprocessable_entity }
+          end
+        end
+      end
+
+      def destroy
+        perform_action
+        respond_to do |format|
+          format.html { redirect_to url_for(resource_class), notice: success_message }
+          format.json { head :no_content }
+        end
+      end
+
+      private
+      def perform_action
+        action_context.perform
+      end
+
+      def action_context
+        @action_context ||= action_class.new(context)
+      end
+
+      def context
+        Xavius::Actions::Context.new(resource: resource, resource_params: -> { resource_params })
+      end
+    end
+  end
+end

data/lib/xavius/controllers/helpers.rb

@@ -0,0 +1,73 @@
+module Xavius
+  module Controllers
+    module Helpers
+      protected
+
+      def resource
+        instance_variable_get(instance_variable_name_for(instance_name))
+      end
+
+      def find_resource
+        if params[:id]
+          resource_class.find(params[:id])
+        else
+          resource_class.new
+        end
+      end
+
+      def resource_class
+        class_name.constantize
+      end
+
+      def resource_human_name
+        resource_class.model_name.human
+      end
+
+      def set_resource
+        instance_variable_set(instance_variable_name_for(instance_name), find_resource)
+      end
+
+      def success_message
+        I18n.t('.success', default: I18n.t(:success, scope: [:resource, action_name], resource_name: resource_human_name))
+      end
+
+      private
+      def action_class
+        infer_user_action_class || "Xavius::Actions::#{action_name.camelize}".constantize
+      end
+
+      def infer_user_action_class
+        "#{module_parent}::#{controller_name.camelize.demodulize}::#{action_name.camelize}Action".safe_constantize ||
+        "#{controller_name.camelize}::#{action_name.camelize}Action".safe_constantize
+      end
+
+      def module_parent
+        if Rails::VERSION::MAJOR > 5
+          resource_class.module_parent
+        else
+          resource_class.parent
+        end
+      end
+
+      def instance_variable_name_for(name)
+        "@#{name}"
+      end
+
+      def class_name
+        controller_name.singularize.camelize.freeze
+      end
+
+      def collection_name
+        infer_from_controller.freeze
+      end
+
+      def instance_name
+        infer_from_controller.singularize.freeze
+      end
+
+      def infer_from_controller
+        controller_name.gsub("/", "_")
+      end
+    end
+  end
+end

data/lib/xavius/controllers/version.rb

@@ -1,5 +1,5 @@
 module Xavius
   module Controllers
-    VERSION = "0.1.0"
+    VERSION = "0.1.2"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xavius-controllers
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Emerson Xavier
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2021-05-29 00:00:00.000000000 Z
+date: 2021-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -67,29 +67,30 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.0'
 description: Keep your controllers clean and reuse common REST behaviour
-email: emersonx.engineer@gmail.com
+email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
-- Gemfile
-- README.md
-- Rakefile
-- bin/console
-- bin/setup
+- lib/generators/xavius/action/USAGE
+- lib/generators/xavius/action/action_generator.rb
+- lib/generators/xavius/action/templates/action.rb
+- lib/xavius/actions/base.rb
+- lib/xavius/actions/context.rb
+- lib/xavius/actions/create.rb
+- lib/xavius/actions/destroy.rb
+- lib/xavius/actions/index.rb
+- lib/xavius/actions/update.rb
 - lib/xavius/controllers.rb
+- lib/xavius/controllers/base.rb
+- lib/xavius/controllers/helpers.rb
 - lib/xavius/controllers/version.rb
-- xavius-controllers.gemspec
 homepage: https://github.com/xavius-rb/xavius/tree/master/xavius-controllers
 licenses:
 - MIT
 metadata:
-  allowed_push_host: https://rubygems.org/
-  homepage_uri: https://github.com/xavius-rb/xavius/tree/master/xavius-controllers
   source_code_uri: https://github.com/xavius-rb/xavius/tree/master/xavius-controllers
+  allowed_push_host: https://rubygems.org/
   changelog_uri: https://github.com/xavius-rb/xavius/tree/master/xavius-controllers/CHANGELOG.md
 post_install_message: 
 rdoc_options: []

data/.gitignore

@@ -1,11 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status

data/.rspec

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

data/.travis.yml

@@ -1,6 +0,0 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 2.7.2
-before_install: gem install bundler -v 2.1.4

data/Gemfile

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

data/README.md

@@ -1,36 +0,0 @@
-# Xavius::Controllers
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/xavius/controllers`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'xavius-controllers'
-```
-
-And then execute:
-
-    $ bundle install
-
-Or install it yourself as:
-
-    $ gem install xavius-controllers
-
-## Usage
-
-TODO: Write usage instructions here
-
-## 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]/xavius-controllers.
-

data/Rakefile

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

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "xavius/controllers"
-
-# 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(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/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/xavius-controllers.gemspec

@@ -1,33 +0,0 @@
-require_relative 'lib/xavius/controllers/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "xavius-controllers"
-  spec.version       = Xavius::Controllers::VERSION
-  spec.authors       = "Emerson Xavier"
-  spec.email         = "emersonx.engineer@gmail.com"
-  spec.summary       = %q{Reusable controller utilities}
-  spec.description   = %q{Keep your controllers clean and reuse common REST behaviour}
-  spec.homepage      = "https://github.com/xavius-rb/xavius/tree/master/xavius-controllers"
-  spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
-
-  spec.metadata["allowed_push_host"] = "https://rubygems.org/"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] =  spec.homepage
-  spec.metadata["changelog_uri"] = "https://github.com/xavius-rb/xavius/tree/master/xavius-controllers/CHANGELOG.md"
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'rspec-rails', '~> 3'
-  spec.add_development_dependency 'activesupport', '>= 5.0'
-  spec.add_development_dependency 'actionpack', '>= 5.0'
-end