sparkl 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1577ca6ac6f682e0522ee114ca3ef1ca9eb8f09a4b001889f2ee24c00952638e
+  data.tar.gz: 8510f89c773ecb4b8ca66ab0445fabd8389848f43e76a5b9d036793a19b2f407
+SHA512:
+  metadata.gz: 8a63e86de7dff24dfa97845fcda624409b74ebec4ce9489e3428aeeae27478e1c4cb623dc846f1ce0e82c9631b87486810c827b73ccd3ed3f03103585035f92c
+  data.tar.gz: 525c60f2b7a6e7decebd6b0d7abf39d479bbe53608659d387b11b719b4f49bf8c076881dbd1dd266ad3e9604b49927c126afaeeee03ee94df2dec55e2bdd86c6

data/.gitignore

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

data/.rspec

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

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in sparkl.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,78 @@
+PATH
+  remote: .
+  specs:
+    sparkl (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (7.0.3.1)
+      actionview (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
+      rack (~> 2.0, >= 2.2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (7.0.3.1)
+      activesupport (= 7.0.3.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activesupport (7.0.3.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    builder (3.2.4)
+    concurrent-ruby (1.1.10)
+    crass (1.0.6)
+    diff-lcs (1.4.4)
+    erubi (1.11.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    loofah (2.18.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mini_portile2 (2.8.0)
+    minitest (5.16.3)
+    nokogiri (1.13.8)
+      mini_portile2 (~> 2.8.0)
+      racc (~> 1.4)
+    racc (1.6.0)
+    rack (2.2.4)
+    rack-test (2.0.2)
+      rack (>= 1.3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.4.3)
+      loofah (~> 2.3)
+    rake (13.0.6)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionpack (>= 5.0)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  sparkl!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Joseph Johansen
+
+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,137 @@
+# Sparkl
+
+Sparkl provides a decorator-like way of writing hooks for your Rails controllers. Example:
+
+```ruby
+class MyController < ApplicationController
+  extend Sparkl::Decoration
+
+  def_decorator :special_auth, before_action: [:auth, if: -> { true or false }]
+
+  special_auth def show
+    # ... normal controller logic here
+  end
+
+  # instead of:
+  # before_action :auth, only: [:show], if: -> { true or false }
+end
+```
+
+Decorators can also be chained:
+
+```ruby
+class MyController < ApplicationController
+  extend Sparkl::Decoration
+
+  def_decorator :no_auth, skip_before_action: :authorize
+  def_decorator :verify_scope, after_action: ->() {
+    # ... logic to check policy scoping...
+  }
+
+  verify_scope no_auth def show
+    # ... normal controller logic here
+  end
+
+  # or with parentheses:
+  # verify_scope(
+  #   no_auth(
+  #     def show
+  #       # ... normal controller logic here
+  #     end
+  #   )
+  # )
+end
+```
+
+and can also be reused:
+
+```ruby
+module MyActions
+  extend Sparkl::Decorator
+
+  def_decorator :redirect_if_true, before_action: [ :handle_redirect, { if: ->{ true } } ]
+
+  private def handle_redirect
+    redirect_to "..."
+  end
+end
+
+class MyController < ApplicationController
+  extend MyActions
+
+  redirect_if_true def index
+    # ...
+  end
+end
+```
+
+`def_decorator` is also aliased as `decorator`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sparkl'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install sparkl
+
+## Usage
+
+See above for examples.
+
+In the decorator definition, you define the moment the action will be performed - it can be
+performed at multiple times if you like:
+
+```ruby
+decorator :foo, before_action: ->{ puts 'foo' }, after_action: ->{ puts :bar }
+```
+
+Available timings mirror Rails' own options:
+
+```
+before_action
+prepend_before_action
+after_action
+prepend_after_action
+skip_before_action
+skip_after_action
+```
+
+Each action can take any of the arguments that a normal rails action would:
+
+```ruby
+decorator :foo, before_action: [:do_foo, if: :condition?]
+
+# ...
+
+# need to have do_foo and condition? methods defined
+def do_foo
+  # ...
+end
+
+def condition?
+  true
+end
+```
+
+## 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 the created tag, 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/johansenja/sparkl.
+
+## 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,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "sparkl"
+
+# 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

@@ -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/sparkl/version.rb

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

data/lib/sparkl.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require_relative "sparkl/version"
+
+module Sparkl
+  class InvalidActionsError < StandardError; end
+
+  DECORATORS_CONST_NAME = "Decorators".freeze
+  private_constant :DECORATORS_CONST_NAME
+
+  module Decoration
+    ACTIONS = %i[
+      before_action
+      after_action
+      skip_before_action
+      skip_after_action
+      prepend_before_action
+      prepend_after_action
+    ].to_set.freeze
+
+    def self.extended(other)
+      super
+      module_container_for_decorator_methods = Module.new
+      other.const_set DECORATORS_CONST_NAME, module_container_for_decorator_methods
+      other.extend(module_container_for_decorator_methods)
+
+      other.define_singleton_method :extended do |beyond|
+        super beyond
+        beyond.extend module_container_for_decorator_methods
+      end
+    end
+
+    def decorator(name, **opts)
+      if opts.empty? or opts.any? { |k, _| !ACTIONS.member?(k.to_sym) }
+        raise InvalidOptionsError, "Invalid options #{opts}. Allowed: #{ACTIONS}"
+      end
+
+      const_get(DECORATORS_CONST_NAME).define_method name do |action_name|
+        opts.each do |opt, args|
+          public_send opt, *args, only: [action_name]
+        end
+
+        action_name
+      end
+    end
+
+    alias def_decorator decorator
+  end
+end

data/sparkl.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/sparkl/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sparkl"
+  spec.version       = Sparkl::VERSION
+  spec.authors       = ["Joseph Johansen"]
+  spec.email         = ["joe@stotles.com"]
+
+  spec.summary       = "Method decorators for your Rails controller actions"
+  spec.description   = "Define behaviours for before, after and around actions using a decorator-like manner, similar to TypeScript or Python."
+  spec.homepage      = "https://github.com/johansenja/sparkl"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.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"] =spec.homepage
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_development_dependency "actionpack", ">= 5.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: sparkl
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joseph Johansen
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-09-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Define behaviours for before, after and around actions using a decorator-like
+  manner, similar to TypeScript or Python.
+email:
+- joe@stotles.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sparkl.rb
+- lib/sparkl/version.rb
+- sparkl.gemspec
+homepage: https://github.com/johansenja/sparkl
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/johansenja/sparkl
+  source_code_uri: https://github.com/johansenja/sparkl
+  changelog_uri: https://github.com/johansenja/sparkl
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Method decorators for your Rails controller actions
+test_files: []