human_routes 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2ad89763d40365e71ad1e2d6ca62e93c9d407cb4342ed0904c1b181338c5a599
+  data.tar.gz: 076fe95f90963ab455b86559c00c0af7dd0aeb624b2a1605c12ab2cccfbd3418
+SHA512:
+  metadata.gz: 2af45ff4d9f08a645a0c2a367a652579ef43e24bd7bb9ad13db111b6be11b9d0952f0fcd6570797279d467948599d9cd4b92881ba48f44ea41a489d1513baad8
+  data.tar.gz: 51122db49e0b50327e3f7dd9751e7f4051425386f5ab59b6c1504819d7d4654fa320f1896c4bb05e17d6eef4f324a5d47a5ad9865e8e174974f9f76f11275bee

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/log
+/Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,12 @@
+---
+inherit_gem:
+  rubocop-fnando: .rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.7
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false

data/.tool-versions

@@ -0,0 +1 @@
+nodejs 12.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 me@fnando.com. 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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in human_routes.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Nando Vieira
+
+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,139 @@
+# human_routes
+
+I never liked REST routing for customer-facing web pages, and until then I've
+been doing it manually, with `get/post` helpers. This gem extracts some helpers
+so I don't have to keep doing it manually. I never use the same controllers
+responding to multiple formats anyway, as I like to keep API in a separate
+endpoint.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "human_routes"
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install human_routes
+
+## Usage
+
+After loading this gem, you'll have a `route` method available on your routes.
+
+```ruby
+Rails.application.routes.draw do
+  route :signup do
+    create
+  end
+end
+```
+
+This will generate a few routes different routes, as you can see below:
+
+```
+$ rails routes
+   Prefix     Verb   URI Pattern   Controller#Action
+   new_signup GET    /signup/new   signup#new
+              POST   /signup/new   signup#create
+```
+
+Notice that routes are generated without the optional `:format` param. Just
+awesome!
+
+A classic "resource" would be represented like this:
+
+```ruby
+Rails.application.routes.draw do
+  route :blogs do
+    create
+    update
+    remove
+    list
+    show
+  end
+end
+```
+
+The above could added in one line with `route(:blogs) { all }`.
+
+This will generate the following routes:
+
+```
+$ rails routes
+     Prefix Verb   URI Pattern        Controller#Action
+   new_blog GET    /blogs/new         blogs#new
+            POST   /blogs/new         blogs#create
+  edit_blog GET    /blogs/:id/edit    blogs#edit
+            POST   /blogs/:id/edit    blogs#update
+remove_blog GET    /blogs/:id/remove  blogs#remove
+            POST   /blogs/:id/remove  blogs#destroy
+      blogs GET    /blogs             blogs#index
+       blog GET    /blogs/:id         blogs#show
+```
+
+The API is quite simple and delegated to
+[ActionDispatch::Routing::Mapper::Base#match](https://api.rubyonrails.org/classes/ActionDispatch/Routing/Mapper/Base.html#method-i-match).
+
+```ruby
+# `options` will be applied to every single route in the block.
+# Can be used to set `format: true`, or `param: :another_id`.
+routes(options = {}, &block)
+
+# Each of the route generators accepts its own path and options.
+# Use it to override the path or set a different named route.
+create(path, &options)
+update(path, &options)
+remove(path, &options)
+list(path, &options)
+show(path, &options)
+
+# In practice, something along these lines.
+Rails.application.routes.draw do
+  route :signup do
+    # This will generate the helper `signup_path` instead of `new_signup_path`.
+    # The route will also be modified to `/signup` instead of `/signup/new`.
+    create "signup", as: "signup"
+  end
+
+  route :pages, module: "customer" do
+    all
+  end
+end
+```
+
+## 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/fnando/human_routes. This project is intended to be a safe,
+welcoming space for collaboration, and contributors are expected to adhere to
+the
+[code of conduct](https://github.com/fnando/human_routes/blob/master/CODE_OF_CONDUCT.md).
+
+## 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 HumanRoutes project's codebases, issue trackers,
+chat rooms and mailing lists is expected to follow the
+[code of conduct](https://github.com/fnando/human_routes/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "rubocop/rake_task"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/bin/console

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "lib/human_routes/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "human_routes"
+  spec.version       = HumanRoutes::VERSION
+  spec.authors       = ["Nando Vieira"]
+  spec.email         = ["me@fnando.com"]
+
+  spec.summary       = "I say no to REST for client-facing urls."
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/fnando/human_routes"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.homepage
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) 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_dependency "rails"
+
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "minitest-utils"
+  spec.add_development_dependency "pry-meta"
+  spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "rubocop-fnando"
+end

data/lib/human_routes.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "action_dispatch/routing/mapper"
+
+module HumanRoutes
+  require_relative "human_routes/version"
+  require_relative "human_routes/extensions"
+  require_relative "human_routes/context"
+
+  ActionDispatch::Routing::Mapper.include(Extensions)
+end

data/lib/human_routes/context.rb

@@ -0,0 +1,164 @@
+# frozen_string_literal: true
+
+module HumanRoutes
+  class Context
+    attr_reader :controller
+    attr_reader :options
+
+    def initialize(controller, options = {})
+      @controller = controller
+      @options = options
+    end
+
+    def singular_controller_name
+      @singular_controller_name ||= controller.to_s.singularize
+    end
+
+    def routes
+      @routes ||= []
+    end
+
+    def create(*args)
+      path, name, options = extract_route_args(
+        default_path: "#{controller}/new",
+        default_name: "new_#{singular_controller_name}",
+        args: args
+      )
+
+      routes << [
+        path,
+        {
+          via: :get,
+          controller: controller,
+          action: :new,
+          as: name
+        }.merge(options)
+      ]
+
+      routes << [
+        path,
+        {
+          via: :post,
+          controller: controller,
+          action: :create,
+          as: ""
+        }.merge(options)
+      ]
+    end
+
+    def update(*args)
+      path, name, options = extract_route_args(
+        default_path: "#{controller}/:id/edit",
+        default_name: "edit_#{singular_controller_name}",
+        args: args
+      )
+
+      routes << [
+        path,
+        {
+          via: :get,
+          controller: controller,
+          action: :edit,
+          as: name
+        }.merge(options)
+      ]
+
+      routes << [
+        path,
+        {
+          via: :post,
+          controller: controller,
+          action: :update,
+          as: ""
+        }.merge(options)
+      ]
+    end
+
+    def remove(*args)
+      path, name, options = extract_route_args(
+        default_path: "#{controller}/:id/remove",
+        default_name: "remove_#{singular_controller_name}",
+        args: args
+      )
+
+      routes << [
+        path,
+        {
+          via: :get,
+          controller: controller,
+          action: :remove,
+          as: name
+        }.merge(options)
+      ]
+
+      routes << [
+        path,
+        {
+          via: :post,
+          controller: controller,
+          action: :destroy,
+          as: ""
+        }.merge(options)
+      ]
+    end
+
+    def list(*args)
+      path, name, options = extract_route_args(
+        default_path: controller,
+        default_name: controller,
+        args: args
+      )
+
+      routes << [
+        path,
+        {
+          via: :get,
+          controller: controller,
+          action: :index,
+          as: name
+        }.merge(options)
+      ]
+    end
+
+    def show(*args)
+      path, name, options = extract_route_args(
+        default_path: "#{controller}/:id",
+        default_name: singular_controller_name,
+        args: args
+      )
+
+      routes << [
+        path,
+        {
+          via: :get,
+          controller: controller,
+          action: :show,
+          as: name
+        }.merge(options)
+      ]
+    end
+
+    def all
+      create
+      update
+      remove
+      list
+      show
+    end
+
+    private def extract_route_args(default_path:, default_name:, args:)
+      route_options = args.extract_options!
+      route_options = default_options.merge(options).merge(route_options)
+      path = args.first || default_path
+      name = route_options.delete(:as) || default_name
+
+      [path, name, route_options]
+    end
+
+    private def default_options
+      {
+        format: false
+      }
+    end
+  end
+end

data/lib/human_routes/extensions.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module HumanRoutes
+  module Extensions
+    def route(controller, options = {}, &block)
+      context = Context.new(controller, options)
+      context.instance_eval(&block)
+
+      context.routes.each do |route|
+        match(*route)
+      end
+    end
+  end
+end

data/lib/human_routes/version.rb

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

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: human_routes
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nando Vieira
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-02-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-utils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-meta
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-fnando
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: I say no to REST for client-facing urls.
+email:
+- me@fnando.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".tool-versions"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- human_routes.gemspec
+- lib/human_routes.rb
+- lib/human_routes/context.rb
+- lib/human_routes/extensions.rb
+- lib/human_routes/version.rb
+homepage: https://github.com/fnando/human_routes
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/fnando/human_routes
+  source_code_uri: https://github.com/fnando/human_routes
+  changelog_uri: https://github.com/fnando/human_routes
+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.1.2
+signing_key: 
+specification_version: 4
+summary: I say no to REST for client-facing urls.
+test_files: []