unobtrusive_resources 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e9ff4b08d28b8530be536bd22d80a4d65cd22a3f207a68de79e40897ba6d3c4b
+  data.tar.gz: 06e8edf697482f0e99e5242f3bfdf32e9da448160fe87dea5f5e6d147e3afce8
+SHA512:
+  metadata.gz: d6ce03f6c26013112bae8675bdf42b51fa506c4abdef3973e59ef20c98636f0511b247a8070a9a889997b9fea86507862d99c75608601575cd3ce2e8df1af631
+  data.tar.gz: db9c2657a73bd571c8cb97029af2c9791e7ea4b827c26138f9dc5498a87b80ea1b7df0ec743df6cf1d27e70ace8f71885cea31e8532e665df308e37d6d6d630b

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+*.gem
+*.rbc
+Gemfile.lock
+mkmf.log

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at sergey@cimon.io. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in unobtrusive_resources.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Serhii Konev
+
+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,115 @@
+# UnobtrusiveResources
+
+This gem provides convenient set of methods for resource management to keep your controllers as "skinny" as possible.
+Main idea is to organize controller actions' code in terms of resource CRUD.
+
+Example:
+
+```ruby
+class BotsController < ApplicationController
+  # ...
+
+  unobtrusive finder_method: :find_by_slug!,
+              find_for_create_by: :slug,
+              resource_class: Bot,
+              relationship_name: :bots,
+              permitted_params_key: :bot,
+              permitted_params_create_value: %i[name code],
+              permitted_params_update_value: %i[name code]
+  def index
+    respond_with(collection)
+  end
+
+  def show
+    respond_with(resource)
+  end
+
+  def new
+    build_resource
+    respond_with(resource)
+  end
+
+  def create
+    find_or_create_resource
+    respond_with(resource)
+  end
+
+  def update
+    update_resource
+    respond_with(resource)
+  end
+
+  def destroy
+    destroy_resource
+    respond_with(resource)
+  end
+  # ...
+end
+```
+
+Keep in mind, that following methods should be defined (or configured with `unobtrusive` method call) in order to make default configuration to work properly:
+
+  - `relationship_name`
+  - `resource_class`
+  - `find_for_create_by`
+  - `permitted_params_key`
+  - `permitted_params_create_value`
+  - `permitted_params_update_value`
+  - `parent_class`
+  - `parent_permitted_params_key`
+
+For real-life projects most resource related actions will be a bit more complicated.
+In such cases we can easily change underlying logic for, say, resource creation (redefine method):
+
+```ruby
+class BotsController < ApplicationController
+  # ...
+
+  private
+
+  # Here `Bot` may be some model class or service object.
+  def create_resource
+    @_resource = Bot.custom_create(permitted_params)
+  end
+  # ...
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'unobtrusive_resources'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install unobtrusive_resources
+
+## Usage
+
+There is no need for additional initializer.
+All necessary methods will be included into `ActionController::Base` via `ActiveSupport.on_load` (lazy load hook).
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/cimon-io/unobtrusive_resources. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the UnobtrusiveResources project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/cimon-io/unobtrusive_resources/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "unobtrusive_resources"
+
+# 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/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/setup

@@ -0,0 +1,8 @@
+#!/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/lib/unobtrusive_resources/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module UnobtrusiveResources
+  VERSION = '0.1.1'
+end

data/lib/unobtrusive_resources.rb

@@ -0,0 +1,235 @@
+# frozen_string_literal: true
+
+require 'unobtrusive_resources/version'
+require 'active_support/concern'
+require 'active_support/lazy_load_hooks'
+
+module UnobtrusiveResources
+  extend ActiveSupport::Concern
+  # required methods
+  #  :relationship_name
+  #  :resource_class
+  #  :find_for_create_by
+  #  :permitted_params_key
+  #  :permitted_params_create_value
+  #  :permitted_params_update_value
+
+  #  :parent_class
+  #  :parent_permitted_params_key
+  included do
+    private_class_method :unobtrusive_method
+    private_class_method :safe_unobtrusive_method
+  end
+
+  class_methods do
+    def unobtrusive_method(method_name, &block)
+      return method_name if private_method_defined?(method_name)
+      return method_name if method_defined?(method_name)
+
+      define_method(method_name, &block)
+      protected method_name
+    end
+
+    def safe_unobtrusive_method(method_name, value)
+      if value.respond_to?(:call)
+        unobtrusive_method(method_name, &value)
+      else
+        unobtrusive_method(method_name) { value }
+      end
+    end
+
+    def unobtrusive(options)
+      helper_method :resource,
+                    :resource_class,
+                    :resource_name,
+                    :resource_collection_name,
+                    :resource_route,
+                    :resource_url,
+                    :new_resource_url,
+                    :edit_resource_url,
+                    :collection,
+                    :collection_route,
+                    :collection_url
+
+      options.each do |key, value|
+        safe_unobtrusive_method(key, value)
+      end
+
+      unobtrusive_method :collection do
+        instance_variable_set(:@_collection, end_of_association_chain) unless instance_variable_defined?(:@_collection)
+        instance_variable_get(:@_collection)
+      end
+
+      unobtrusive_method :resource do
+        instance_variable_set(:@_resource, end_of_association_chain.public_send(finder_method, unobtrusive_params[finder_param])) unless instance_variable_defined?(:@_resource)
+        instance_variable_get(:@_resource)
+      end
+
+      unobtrusive_method :build_resource do
+        instance_variable_set(:@_resource, end_of_association_chain.build)
+        instance_variable_get(:@_resource).assign_attributes(build_permitted_params)
+        instance_variable_get(:@_resource)
+      end
+
+      unobtrusive_method :find_or_create_resource do
+        instance_variable_set(
+          :@_resource,
+          end_of_association_chain.find_by(find_for_create_by => permitted_params[find_for_create_by]) || end_of_association_chain.build.tap { |r| r.update(permitted_params) }
+        )
+      end
+
+      unobtrusive_method :create_resource do
+        instance_variable_set(
+          :@_resource,
+          end_of_association_chain.build.tap { |r| r.update(permitted_params) }
+        )
+      end
+
+      unobtrusive_method :update_resource do
+        resource.update(permitted_params)
+      end
+
+      unobtrusive_method :destroy_resource do
+        resource.destroy
+      end
+
+      unobtrusive_method :association_chain do
+        begin_of_association_chain.public_send(relationship_name)
+      end
+
+      unobtrusive_method :association_chain_with_accessible do
+        association_chain
+      end
+
+      unobtrusive_method :association_chain_with_includes do
+        association_chain_with_accessible
+      end
+
+      unobtrusive_method :end_of_association_chain do
+        association_chain_with_includes
+      end
+
+      unobtrusive_method :unobtrusive_params do
+        params
+      end
+
+      unobtrusive_method :finder_method do
+        :find
+      end
+
+      unobtrusive_method :finder_param do
+        :id
+      end
+
+      unobtrusive_method :resource_collection_name do
+        resource_class.model_name.plural
+      end
+
+      unobtrusive_method :resource_name do
+        resource_class.model_name.singular
+      end
+
+      # TODO: remove this method.
+      # Looks like this method is not used.
+      unobtrusive_method :relationship_singular_name do
+        resource_class.to_s.underscore.to_sym
+      end
+
+      unobtrusive_method :permitted_params do
+        unobtrusive_params.permit(permitted_params_key => send("permitted_params_#{action_name}_value"))[permitted_params_key]
+      end
+
+      unobtrusive_method :build_permitted_params do
+        {}
+      end
+
+      unobtrusive_method :collection_url do |*args|
+        url_for(collection_route(*args))
+      end
+
+      unobtrusive_method :resource_url do |*args|
+        url_for(resource_route(args))
+      end
+
+      unobtrusive_method :resource_route do |*args|
+        [resource, *args]
+      end
+
+      unobtrusive_method :edit_resource_url do |*args|
+        url_for(edit_resource_route(*args))
+      end
+
+      unobtrusive_method :edit_resource_route do |*args|
+        [:edit, resource, *args]
+      end
+
+      unobtrusive_method :new_resource_url do |*args|
+        url_for(new_resource_route(*args))
+      end
+
+      unobtrusive_method :new_resource_route do |*args|
+        [:new, resource_name, *args]
+      end
+
+      # parent methods
+      if method_defined?(:parent_class) || private_method_defined?(:parent_class)
+        helper_method :parent, :parent_class, :parent_name, :parent_collection_name, :parent_url
+
+        unobtrusive_method :parent do
+          instance_variable_set(:@_parent, parent_class.public_send(parent_finder_method, unobtrusive_params[parent_finder_param])) unless instance_variable_defined?(:@_parent)
+          instance_variable_get(:@_parent)
+        end
+
+        # TODO: Rename `unoptrusive_parent_params` => `unobtrusive_parent_params`
+        # Check if this method is used in existing repositories.
+        unobtrusive_method :unoptrusive_parent_params do
+          params
+        end
+
+        unobtrusive_method :parent_finder_method do
+          :find
+        end
+
+        unobtrusive_method :parent_finder_param do
+          :id
+        end
+
+        unobtrusive_method :parent_collection_name do
+          parent_class.model_name.plural
+        end
+
+        unobtrusive_method :parent_name do
+          parent_class.model_name.singular
+        end
+
+        unobtrusive_method :parent_url do |*args|
+          url_for(parent_route(*args))
+        end
+
+        unobtrusive_method :parent_route do |*args|
+          [parent, *args]
+        end
+        
+        unobtrusive_method :collection_route do |*args|
+          [parent, relationship_name, *args]
+        end        
+
+        unobtrusive_method :begin_of_association_chain do
+          parent
+        end
+      else
+        unobtrusive_method :begin_of_association_chain do
+          OpenStruct.new(relationship_name => resource_class.all)
+        end
+        
+        unobtrusive_method :collection_route do |*args|
+          [relationship_name, *args]
+        end        
+      end
+    end
+  end
+end
+
+ActiveSupport.on_load(:action_controller) do
+  include(::UnobtrusiveResources) if self == ActionController::Base
+end

data/unobtrusive_resources.gemspec

@@ -0,0 +1,37 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'unobtrusive_resources/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'unobtrusive_resources'
+  spec.version       = UnobtrusiveResources::VERSION
+  spec.authors       = ['Alexey Osipenko', 'Serhii Konev']
+  spec.email         = ['alexey@cimon.io', 'sergey@cimon.io']
+
+  spec.summary       = 'Controller concern for skinny, concise and declarative actions'
+  spec.description   = 'This gem provides number of utility methods to cleanup codebase, related to controllers. Extremely usefull for common resource management actions (CRUD).'
+  spec.homepage      = 'https://github.com/cimon-io/unobtrusive_resources'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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_dependency 'activesupport', '>= 3.0', '< 8.0'
+
+  spec.add_development_dependency 'bundler', '~> 2.2.33'
+  spec.add_development_dependency 'rake', '~> 12'
+  spec.add_development_dependency 'rspec', '~> 3.7'
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: unobtrusive_resources
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Alexey Osipenko
+- Serhii Konev
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-12-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.33
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.33
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+description: This gem provides number of utility methods to cleanup codebase, related
+  to controllers. Extremely usefull for common resource management actions (CRUD).
+email:
+- alexey@cimon.io
+- sergey@cimon.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/rspec
+- bin/setup
+- lib/unobtrusive_resources.rb
+- lib/unobtrusive_resources/version.rb
+- unobtrusive_resources.gemspec
+homepage: https://github.com/cimon-io/unobtrusive_resources
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.2.3
+signing_key:
+specification_version: 4
+summary: Controller concern for skinny, concise and declarative actions
+test_files: []