implicit_resource 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8dc570c2c5edb6829f36082a1a55640a9eb28cf6327130f6bf71b8507b6eab4
-  data.tar.gz: 0aead15c4e3f4f49c5459c4c93ef090f4f9e179afefe4c04dd0ea5383679e89a
+  metadata.gz: 8cd6ad0e6c6212045d4b6d3fb2eec3ca9c901d4624533f7ed9fa7f2feedc179b
+  data.tar.gz: b4efa30d7b1c6a7706be07ee362d0cfb600dbd4f53a3cfe44f12b42cc9f8bfc9
 SHA512:
-  metadata.gz: 0f760d816d04c14e19a54972dad0802b79aa54be69d5170f0e9edf9060b96a5f8fac7208d7b8e81d3c061c225bc2873712a9d1a512932a2c7c16e45ec31356ba
-  data.tar.gz: 8e8a7c20ac40524bb3460adc5dc6bf8b3d90d66d05d9b2a424af2c14a7e5a3eccf8a1822eb9245f333b78419999edb701a288f0fbe7fd415e86cbbf78b30726e
+  metadata.gz: 4044df37cf13a185176605427545fee16359ffa68eb8d0b1f88e31355b815b3634fa0af163aa15f4c932f31e36beefe5c522af7582244b47649b30426c4a2292
+  data.tar.gz: 9af3ce0fe668ca9b748f744d759b2f3f47a306bf3cda310f24ddca4341b10084e502e9490d2d010bcdbbf44bfda64914239fa7cd78a5187956bfa380f0a8802a

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 
+
+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,78 @@
+## ImplicitResource
+
+In most cases you will have the same old code in your controllers, this gem allows some very basic assumptions while giving you the option to override the behavior. This allows your controllers to be limited to just the required code.
+
+Assumptions this code makes:
+1. The controller is named for the model. e.g. `ArticlesController` will assume `Article` model.
+2. Standard restful actions: `index`, `show`, `new`, `create`, `edit`, `update`, `destroy`.
+3. A method named `permitted_attributes` exists for `permitted_params`.
+
+Here's an example of the bare minimum code required to get started:
+
+```ruby
+ArticlesController < ApplicationController
+  include ImplicitResource # Opt in to implicit behavior, or include it in ApplicationController.
+
+  private
+
+  def permitted_params
+    params.require(:article).permit(:title, :body)
+  end
+end
+```
+
+## Installationc
+Add this line to your application's Gemfile:
+
+```ruby
+gem "implicit_resource"
+```
+
+Add this line to your controller
+
+```ruby
+include ImplicitResource
+```
+
+### Customization
+
+ImplicitResource only targets basic controller functionality. Everything that `implicit_resource` does can be overriden in the controller.
+
+#### Overriding resource methods
+
+You can override the `collection` and `resource` methods to achieve more flexibility in how things are queried.
+
+```ruby
+ArticlesController < ApplicationController
+  include ImplicitResource
+
+  private
+
+  def collection # Collection is a placeholder for any collection of objects to be returned
+    model_klass.includes(:comments).search(title: params[:title_search_terms])
+  end
+
+  def resource # Resource is a placeholder for any single object to be returned
+    collection.find_by(token_id: params[:token_id])
+  end
+end
+```
+
+#### Overriding the model class
+
+You can override the `model_klass` method to allow for controller/model naming mismatch.
+
+```ruby
+ArticlesController < ApplicationController
+  include ImplicitResource
+
+  private
+
+  def model_klass
+    Story
+  end
+end
+```
+
+## 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,3 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"

data/lib/implicit_resource/railtie.rb

@@ -0,0 +1,4 @@
+module ImplicitResource
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/implicit_resource/version.rb

@@ -0,0 +1,3 @@
+module ImplicitResource
+  VERSION = "0.1.0"
+end

data/lib/implicit_resource.rb

@@ -1,21 +1,17 @@
+require "implicit_resource/version"
+require "implicit_resource/railtie"
+require "responders"
+require "has_scope"
+
 module ImplicitResource
   extend ActiveSupport::Concern
 
-  included do
-    %i[index show destroy].each do |action|
-      define_method(action) do
-        response_object = (action == :index ? collection : act_on_resource)
-        respond_with(response_object)
-      end
-    end
+  ACTIONS = [:index, :show, :new, :create, :edit, :update, :destroy]
 
-    %i[create update].each do |action|
+  included do
+    ACTIONS.each do |action|
       define_method(action) do
-        if act_on_resource.errors.empty?
-          respond_with('', location: resource_location)
-        else
-          respond_with(act_on_resource)
-        end
+        respond_with(action == :index ? collection : act_on_resource)
       end
     end
 
@@ -25,10 +21,6 @@ module ImplicitResource
 
   protected
 
-  def resource_location
-    (namespace << act_on_resource)
-  end
-
   def namespace
     @namespace ||= controller_path.split('/')[0..-2].map(&:to_sym)
   end
@@ -38,7 +30,7 @@ module ImplicitResource
   end
 
   def collection
-    @collection ||= policy_scope(apply_scopes(model_klass))
+    @collection ||= apply_scopes(model_klass.all)
   end
 
   def resource
@@ -49,25 +41,7 @@ module ImplicitResource
     end
   end
 
-  # If the resource references user(s) go ahead and set with the current user
-  def assign_current_user
-    return unless current_user && resource.new_record?
-    resource.users << current_user if resource.respond_to?(:users=)
-    resource.user ||= current_user if resource.respond_to?(:user=)
-  end
-
-  # Assign some common associations if needed. This
-  # needs to be done before authorization
-  #
-  def bootstrap_resource
-    resource.tap do
-      assign_current_organization
-      assign_current_user
-    end
-  end
-
   # Persist the passed in resource to the database
-  #
   def persist_resource
     return unless %w[create update].include?(action_name)
 
@@ -78,19 +52,14 @@ module ImplicitResource
   end
 
   # Delete the given resource from the database
-  #
   def destroy_resource
     resource.destroy! if action_name == 'destroy'
   end
 
   # Build a resource based on contextual info
-  #
   def act_on_resource
     @act_on_resource ||= resource.tap do
-      authorize(resource)
-
       unless destroy_resource
-        bootstrap_resource
         persist_resource
       end
     end

data/lib/tasks/implicit_resource_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :implicit_resource do
+#   # Task goes here
+# end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: implicit_resource
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Mike Kelley
@@ -9,18 +9,69 @@ autorequire:
 bindir: bin
 cert_chain: []
 date: 2024-03-29 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: responders
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: has_scope
+  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: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7'
 description: Rails Controller Boilerplate
-email: mike@codezombie.org
+email:
+- mike@codezombie.org
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- MIT-LICENSE
+- README.md
+- Rakefile
 - lib/implicit_resource.rb
-homepage: https://rubygems.org/gems/implicit_resource
+- lib/implicit_resource/railtie.rb
+- lib/implicit_resource/version.rb
+- lib/tasks/implicit_resource_tasks.rake
+homepage: https://github.com/codezomb/implicit_resource
 licenses:
 - MIT
-metadata: {}
+metadata:
+  source_code_uri: https://github.com/codezomb/implicit_resource
+  homepage_uri: https://github.com/codezomb/implicit_resource
 post_install_message:
 rdoc_options: []
 require_paths: