action_link 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1fb82eefce04018119e077392dd55980535cb21407adcb14988605f199bd3e42
+  data.tar.gz: ea83ec0bf21af581e71ec2a79783adb97a3e65f8fe91ef43d1ef241f1ad56232
+SHA512:
+  metadata.gz: b1f640474051d8720d8de893567ded1129277abde85b36f07d2c2d16932dd2d7a1c7b349dd9a9c23f274f67d4892f5b68ac14427f20c930887b996546a29e214
+  data.tar.gz: b142f701ff7b43541fb9a5d99c98ec297e1480701b0dfeab848b243662c5c05c5abcc2c42ced17333e615380064f5a8c10e34a88d219f1436b0188aeb21c93ec

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-08-24
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 halo
+
+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,34 @@
+# ActionLink
+
+Intuitive ViewComponents for CRUD resource link actions in Rails.
+
+## Usage
+
+```ruby
+# In Rails view
+= render ActionLink::Show.new(url: [:admin, @post], current_user:)
+```
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add action_link
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install action_link
+
+## 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.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/halo/action_link.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+The icons are taken from the incredible [iconmonstr](https://iconmonstr.com/license/).

data/app/assets/stylesheets/action_link/acticons.sass

@@ -0,0 +1,9 @@
+.o-acticon
+  font-family: 'acticons'
+  speak: none
+  font-style: normal
+  font-weight: normal
+  font-variant: normal
+  text-transform: none
+  -webkit-font-smoothing: antialiased
+  -moz-osx-font-smoothing: grayscale

data/app/assets/stylesheets/action_link/all.sass

@@ -0,0 +1,4 @@
+@import ./variables
+@import ./style
+@import ./fonts
+@import ./acticons

data/app/assets/stylesheets/action_link/fonts.sass

@@ -0,0 +1,5 @@
+@font-face
+  font-family: 'acticons'
+  font-weight: normal
+  font-style: normal
+  src: url('action_link/acticons.woff') format('woff')

data/app/assets/stylesheets/action_link/style.scss

@@ -0,0 +1,42 @@
+// This file is autogenerated by `rake acticons:update`
+
+.o-acticon--info-circle {
+  &:before {
+    content: $o-acticon--info-circle;
+  }
+}
+.o-acticon--questionmark {
+  &:before {
+    content: $o-acticon--questionmark;
+  }
+}
+.o-acticon--arrow-down-circle {
+  &:before {
+    content: $o-acticon--arrow-down-circle;
+  }
+}
+.o-acticon--pencil-circle {
+  &:before {
+    content: $o-acticon--pencil-circle;
+  }
+}
+.o-acticon--check-circle {
+  &:before {
+    content: $o-acticon--check-circle;
+  }
+}
+.o-acticon--chevron-circle-right {
+  &:before {
+    content: $o-acticon--chevron-circle-right;
+  }
+}
+.o-acticon--plus-circle {
+  &:before {
+    content: $o-acticon--plus-circle;
+  }
+}
+.o-acticon--times-circle {
+  &:before {
+    content: $o-acticon--times-circle;
+  }
+}

data/app/assets/stylesheets/action_link/variables.scss

@@ -0,0 +1,10 @@
+// This file is autogenerated by `rake acticons:update`
+
+$o-acticon--info-circle: "\e907";
+$o-acticon--questionmark: "\2753";
+$o-acticon--arrow-down-circle: "\e9af";
+$o-acticon--pencil-circle: "\e9ae";
+$o-acticon--check-circle: "\e93b";
+$o-acticon--chevron-circle-right: "\e928";
+$o-acticon--plus-circle: "\e919";
+$o-acticon--times-circle: "\e91a";

data/app/components/action_link/application_component.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module ActionLink
+  # A component that every other component inherits from in this gem.
+  # It adds convenience methods for initialization of a component.
+  class ApplicationComponent < ViewComponent::Base
+    extend Dry::Initializer
+
+    # By default, Dry::Initializer doesn't complain about invalid arguments.
+    # We want it to raise an error.
+    def initialize(...)
+      __check_for_unknown_options(...)
+      super
+    end
+
+    private
+
+    def __check_for_unknown_options(*args, **kwargs)
+      return if __defined_options.empty?
+
+      # Checking params
+      opts = args.drop(__defined_params.length).first || kwargs
+      raise ArgumentError, "Unexpected argument #{opts}" unless opts.is_a? Hash
+
+      # Checking options
+      unknown_options = opts.keys - __defined_options
+      message = "Key(s) #{unknown_options} not found in #{__defined_options}"
+      raise KeyError, message if unknown_options.any?
+    end
+
+    def __defined_options
+      self.class.dry_initializer.options.map(&:source)
+    end
+
+    def __defined_params
+      self.class.dry_initializer.params.map(&:source)
+    end
+  end
+end

data/app/components/action_link/base.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+module ActionLink
+  # A component that every action link inherits from.
+  # It adds the API that all action links have in common.
+  class Base < ApplicationComponent
+    # The following options are common for all subclasses.
+
+    # Authorization
+    option :current_user # User passed to the policy
+    option :policy_library, as: :manual_policy_library, default: -> {}
+    option :policy_subject, as: :manual_policy_subject, default: -> {} # Record passed to the policy
+
+    # Visualization
+    option :icon, default: -> {}
+
+    # The following options may vary for different subclasses.
+    # Here, in the superclass, they're all defined as optional.
+    option :class, as: :css_class, default: -> {}
+    option :data, default: -> {}
+    option :model, as: :manual_model, default: -> {}
+    option :i18n_model, as: :manual_i18n_model, default: -> {}
+    option :title, as: :manual_title, default: -> {}
+    option :url, default: -> {}
+
+    def permission?
+      _policy.public_send(:"#{_action}?")
+    end
+
+    # Allows you to turn off the icon.
+    def icon?
+      icon != false
+    end
+
+    def icon_tag(name)
+      helpers.content_tag :i, nil,
+                          class: "o-acticon o-acticon--#{name}"
+    end
+
+    def options
+      {
+        title: _title,
+        class: _class,
+        data: _data,
+        target: _target,
+        method: http_method
+      }
+    end
+
+    private
+
+    # May be accessed and/or overriden in subclasses
+
+    def i18n_title_key
+      "action_link_component.titles.#{_action}"
+    end
+
+    def http_method; end
+    def confirmation; end
+
+    def default_confirmation_subject
+      _title_subject_name
+    end
+
+    # Below this point, strictly internal to this superclass.
+    # If you find yourself overwriting any of these methods, question the concept.
+    # Don't call these methods from the view, either.
+
+    # Options for `link_to`
+
+    def _title
+      t(i18n_title_key, subject: strip_tags(_title_subject_name))
+    end
+
+    def _data
+      (data || {}).merge(confirm: confirmation)
+    end
+
+    def _class
+      ['c-action-link', css_class].join(' ').squish
+    end
+
+    def _target
+      :_blank if url.to_s.start_with?('http:') || url.to_s.start_with?('https:')
+    end
+
+    def _additional_data
+      { confirm: confirmation }
+    end
+
+    # Helpers
+
+    def _model
+      @_model ||= ::ActionLink::Model.call(manual_model:, url:)
+    end
+
+    # Converts a class like `::ActionLink::New` to the symbol `:new`.
+    def _action
+      @_action ||= self.class.name[12..].underscore.to_sym
+    end
+
+    def _title_subject_name
+      @_title_subject_name ||= ::ActionLink::TitleSubjectName.call(
+        manual_title:,
+        manual_i18n_model:,
+        model: _model
+      )
+    end
+
+    def _policy_subject
+      manual_policy_subject ||
+        _model ||
+        raise("Expected a policy subject #{self}")
+    end
+
+    def _policy_library
+      manual_policy_library || :auto
+    end
+
+    def _policy
+      if (_policy_library == :auto && defined?(::ActionPolicy)) || _policy_library == :action_policy
+        _policy_from_action_policy
+      elsif (_policy_library == :auto && defined?(::Pundit)) || _policy_library == :pundit
+        _policy_from_pundit
+      else
+        raise 'Implement me in a sane way, once it is actually needed'
+      end
+    end
+
+    def _policy_from_action_policy
+      ::ActionPolicy.lookup(_policy_subject).new(_policy_subject, user: current_user)
+    end
+
+    def _policy_from_pundit
+      ::Pundit.policy!(current_user, _policy_subject)
+    end
+  end
+end

data/app/components/action_link/destroy.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module ActionLink
+  # An action link that indicates deleting a new record.
+  class Destroy < Base
+    ICON = 'times-circle'
+
+    erb_template <<~ERB.gsub("\n", '')
+      <% if permission? %>
+      <%= link_to(url, **options) do %>
+      <%= content %>
+      <% if icon? %><%= ' ' %><%= icon_tag ::ActionLink::Destroy::ICON %><% end %>
+      <% end %>
+      <% else %>
+      <%= content %>
+      <% end %>
+    ERB
+
+    option :url
+    option :confirmation, as: :manual_confirmation, default: -> {}
+    option :confirmation_subject, default: -> {}
+    option :associative, default: -> { false }
+
+    def i18n_title_key
+      return 'action_link_component.titles.unassign' if associative
+
+      super
+    end
+
+    def confirmation
+      return manual_confirmation if manual_confirmation
+
+      I18n.t(i18n_confirmation_key,
+             subject: strip_tags(confirmation_subject || default_confirmation_subject))
+    end
+
+    def http_method
+      :delete
+    end
+
+    private
+
+    def i18n_confirmation_key
+      if associative
+        'action_link_component.confirmations.unassign'
+      else
+        'action_link_component.confirmations.destroy'
+      end
+    end
+  end
+end

data/app/components/action_link/edit.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module ActionLink
+  # An action link that indicates editing an existing record.
+  class Edit < Base
+    ICON = 'pencil-circle'
+
+    erb_template <<~ERB.gsub("\n", '')
+      <% if permission? %>
+      <%= link_to(url, **options) do %>
+      <%= content %>
+      <% if icon? %><%= ' ' %><%= icon_tag ::ActionLink::Edit::ICON %><% end %>
+      <% end %>
+      <% else %>
+      <%= content %>
+      <% end %>
+    ERB
+
+    option :url
+  end
+end

data/app/components/action_link/new.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module ActionLink
+  # An action link that indicates adding a new record.
+  class New < Base
+    ICON = 'plus-circle'
+
+    erb_template <<~ERB.gsub("\n", '')
+      <% if permission? %>
+      <%= link_to(url, **options) do %>
+      <%= content %>
+      <% if icon? %><%= ' ' %><%= icon_tag ::ActionLink::New::ICON %><% end %>
+      <% end %>
+      <% else %>
+      <%= content %>
+      <% end %>
+    ERB
+
+    # `model:` is mandatory because `[:new, :admin, Klass]` would
+    # translate to the route `[:new, :admin, :klasses]` and that's incorrect (plural vs singular).
+    option :model, as: :manual_model
+    option :url
+    option :associative, default: -> { false }
+
+    def i18n_title_key
+      return 'action_link_component.titles.assign' if associative
+
+      super
+    end
+  end
+end

data/app/components/action_link/show.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module ActionLink
+  # An action link that indicates showing an existing record.
+  class Show < Base
+    ICON = 'chevron-circle-right'
+
+    erb_template <<~ERB.gsub("\n", '')
+      <% if permission? %>
+      <%= link_to(url, **options) do %>
+      <%= content %>
+      <% if icon? %><%= ' ' %><%= icon_tag ::ActionLink::Show::ICON %><% end %>
+      <% end %>
+      <% else %>
+      <%= content %>
+      <% end %>
+    ERB
+
+    option :url
+  end
+end

data/config/locales/action_link_component.de.yml

@@ -0,0 +1,12 @@
+de:
+  action_link_component:
+    confirmations:
+      destroy: "Möchtest du %{subject} löschen?"
+      unassign: "Möchtest du %{subject} entkoppeln? Bei dieser Aktion wird nichts gelöscht."
+    titles:
+      assign: "%{subject} zuweisen"
+      destroy: "%{subject} löschen"
+      edit: "%{subject} bearbeiten"
+      new: "%{subject} anlegen"
+      show: "%{subject} anzeigen"
+      unassign: "%{subject} entkoppeln"

data/config/locales/action_link_component.en.yml

@@ -0,0 +1,12 @@
+en:
+  action_link_component:
+    confirmations:
+      destroy: "Would you like to delete %{subject}?"
+      unassign: "Would you like to unassign %{subject}? This action does not delete."
+    titles:
+      assign: "Assign %{subject}"
+      destroy: "Delete %{subject}"
+      edit: "Edit %{subject}"
+      new: Add %{subject}
+      show: "Show %{subject}"
+      unassign: "Unassign %{subject}"

data/lib/action_link/engine.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'rails/engine'
+require 'dry-initializer'
+
+module ActionLink
+  # :nodoc:
+  class Engine < ::Rails::Engine
+    isolate_namespace ActionLink
+
+    config.to_prepare do
+      # Our ActionLink components are subclasses of `ViewComponent::Base`.
+      # When `ViewComponent::Base` is subclassed, two things happen:
+      #
+      #   1. Rails routes are included into the component
+      #   2. The ViewComponent configuration is accessed
+      #
+      # So we can only require our components, once Rails has booted
+      # AND the view_component gem has been fully initialized (configured).
+      #
+      # That's right here and now.
+      require_relative '../../app/components/action_link/application_component'
+      require_relative '../../app/components/action_link/base'
+      require_relative '../../app/components/action_link/destroy'
+      require_relative '../../app/components/action_link/edit'
+      require_relative '../../app/components/action_link/new'
+      require_relative '../../app/components/action_link/show'
+    end
+  end
+end

data/lib/action_link/model.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module ActionLink
+  # Extracts a model from the provided model options.
+  class Model
+    include Calls
+
+    option :manual_model
+    option :url
+
+    def call
+      model.respond_to?(:model_name) ||
+        raise(MissingModelError, "Model `#{model.inspect}` must respond to #model_name")
+
+      model
+    end
+
+    private
+
+    def model
+      return manual_model if manual_model
+
+      url.last if url.is_a?(Array)
+    end
+  end
+end

data/lib/action_link/title_subject_name.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module ActionLink
+  # Extracts a model from the provided i18n options.
+  class TitleSubjectName
+    include Calls
+
+    option :manual_title
+    option :manual_i18n_model
+    option :model
+
+    def call
+      manual_title || compliant_model.model_name.human
+    end
+
+    private
+
+    def compliant_model
+      compliant_manual_model || model
+    end
+
+    def compliant_manual_model
+      return unless manual_i18n_model
+      return manual_i18n_model if manual_i18n_model.respond_to?(:model_name)
+
+      raise ArgumentError,
+            "Expected `i18n_model:` `#{manual_i18n_model.inspect}` to respond to `#model_name`"
+    end
+  end
+end

data/lib/action_link/version.rb

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

data/lib/action_link.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'dry/initializer'
+require 'calls'
+
+require 'action_link/version'
+require 'action_link/model'
+require 'action_link/title_subject_name'
+
+require 'action_link/engine' if defined?(Rails::Engine)
+
+module ActionLink
+  class Error < ::StandardError; end
+  class MissingModelError < Error; end
+  class SubclassNameError < Error; end
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: action_link
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- halo
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-06-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionview
+  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: calls
+  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: dry-initializer
+  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: view_component
+  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'
+description: Every action has an icon, such as a "plus-sign" for the "new" action
+email:
+- github@posteo.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- app/assets/fonts/action_link/acticons.woff
+- app/assets/stylesheets/action_link/acticons.sass
+- app/assets/stylesheets/action_link/all.sass
+- app/assets/stylesheets/action_link/fonts.sass
+- app/assets/stylesheets/action_link/style.scss
+- app/assets/stylesheets/action_link/variables.scss
+- app/components/action_link/application_component.rb
+- app/components/action_link/base.rb
+- app/components/action_link/destroy.rb
+- app/components/action_link/edit.rb
+- app/components/action_link/new.rb
+- app/components/action_link/show.rb
+- config/locales/action_link_component.de.yml
+- config/locales/action_link_component.en.yml
+- lib/action_link.rb
+- lib/action_link/engine.rb
+- lib/action_link/model.rb
+- lib/action_link/title_subject_name.rb
+- lib/action_link/version.rb
+homepage: https://github.com/halo/action_link
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/halo/action_link
+  source_code_uri: https://github.com/halo/action_link
+  changelog_uri: https://github.com/halo/halo/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.6
+signing_key:
+specification_version: 4
+summary: A set of ViewComponents for common links (show, edit, delete, etc.)
+test_files: []