versioned-routes-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 63e9e22cc102712233d0ebc24b54dcea25d5e0879b55455d41675956063439b2
+  data.tar.gz: cf42d4dd12c33f109891cf9defb68b2afc0f1527fd9159f4a06ec3b56f546621
+SHA512:
+  metadata.gz: cdaf2619c06eeeddf0219b3c11d294fbbb978f4d6b691fe462179305748f4dfed5e71d4c682210e58cd01db389d1865f619b482888d8807944ffd7f87b5fa902
+  data.tar.gz: 786729d9a02996b1060d00bb5a5397d84b91a4f0de41e7038cb72978c1882cf2fedffa6a8296e22c58fa9a996e0c3d5f303bdddc48203bfe808e68de6b199be8

data/.byebug_history

@@ -0,0 +1,13 @@
+c
+Rails.application.routes.recognize_path '/api/v1/messages'
+c
+Rails.application.routes.routes.first.path.spec.to_s
+Rails.application.routes.routes.first.path.spec
+Rails.application.routes.routes.first.path
+Rails.application.routes.routes.first.to_s
+Rails.application.routes.routes.first
+c
+Rails.application.routes.routes.first
+Rails.application.routes.routes
+Rails.application.routes.first
+Rails.application.routes

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,52 @@
+AllCops:
+  TargetRubyVersion: 2.7.1
+  NewCops: enable
+
+Metrics/ClassLength:
+  Max: 1500
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Layout/DotPosition:
+  EnforcedStyle: leading
+
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false
+
+Layout/EndOfLine:
+  EnforcedStyle: lf
+
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Layout/MultilineAssignmentLayout:
+  EnforcedStyle: same_line
+
+Layout/CaseIndentation:
+  EnforcedStyle: end
+
+Layout/EndAlignment:
+  EnforcedStyleAlignWith: variable
+
+Metrics/BlockLength:
+  ExcludedMethods:
+    - class_methods

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in versioned-routes-rails.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'

data/Gemfile.lock

@@ -0,0 +1,126 @@
+PATH
+  remote: .
+  specs:
+    versioned-routes-rails (0.1.0)
+      actionpack
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (6.0.3.2)
+      actionview (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+      rack (~> 2.0, >= 2.0.8)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (6.0.3.2)
+      activesupport (= 6.0.3.2)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activesupport (6.0.3.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    ast (2.4.1)
+    builder (3.2.4)
+    byebug (11.1.3)
+    combustion (1.3.0)
+      activesupport (>= 3.0.0)
+      railties (>= 3.0.0)
+      thor (>= 0.14.6)
+    concurrent-ruby (1.1.6)
+    crass (1.0.6)
+    diff-lcs (1.4.4)
+    erubi (1.9.0)
+    i18n (1.8.4)
+      concurrent-ruby (~> 1.0)
+    loofah (2.6.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (1.0.0)
+    mini_portile2 (2.4.0)
+    minitest (5.14.1)
+    nokogiri (1.10.10)
+      mini_portile2 (~> 2.4.0)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.20.3, < 2.0)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-rails (4.0.1)
+      actionpack (>= 4.2)
+      activesupport (>= 4.2)
+      railties (>= 4.2)
+      rspec-core (~> 3.9)
+      rspec-expectations (~> 3.9)
+      rspec-mocks (~> 3.9)
+      rspec-support (~> 3.9)
+    rspec-support (3.9.3)
+    rubocop (0.88.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.1.0, < 1.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.2.0)
+      parser (>= 2.7.0.1)
+    ruby-progressbar (1.10.1)
+    sqlite3 (1.4.2)
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.7.0)
+    zeitwerk (2.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug
+  combustion (~> 1.3)
+  rake (~> 12.0)
+  rspec
+  rspec-rails
+  rubocop
+  sqlite3
+  versioned-routes-rails!
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -0,0 +1,80 @@
+# VersionedRoutes
+
+`versioned-routes-rails` adds a single method to the Rails `routes.rb` DSL,`version`, which allows you to specify API versions.
+
+When a user requests a specific version of an action, the closest version of that route is matched, starting with the requested version and going down to 1. This allows you to only specify a subset of routes to add or replace in subsequent API versions, allowing all the unmodified routes to fall through to the previous version.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'versioned-routes-rails'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install versioned-routes-rails
+
+## Usage
+
+Controllers must be namespaced as `VN::ThingController`, where `N` is the API version.
+
+For example, let's define our V1 API as a set of `Message` resources, with some member actions. These will map to `V1::MessagesController`.
+
+Our V2 API will only change the logic of `V1::MessagesController#show`, so we'll only specify that action in the `version 2` block. Requests to `/api/v2/messages/:id` will be routed to `V2::MessagesController#show`, while all other `/api/v2/messages` requests will still be routed to `V1::MessagesController`.
+
+```ruby
+Rails.application.routes.draw do
+  scope :api do
+    version 1 do
+      resources :messages do
+        member do
+          post :read
+        end
+      end
+    end
+
+    version 2 do
+      resources :messages, only: [:show]
+    end
+  end
+end
+```
+
+```bash
+$ rake routes
+```
+
+```text
+                   Prefix Verb   URI Pattern                                                                              Controller#Action
+      read_v1_message POST   /api/v1/messages/:id/read(.:format)                                                  v1/messages#read {:format=>:json, :api_version=>1}
+          v1_messages GET    /api/v1/messages(.:format)                                                           v1/messages#index {:format=>:json, :api_version=>1}
+                          POST   /api/v1/messages(.:format)                                                           v1/messages#create {:format=>:json, :api_version=>1}
+           v1_message GET    /api/v1/messages/:id(.:format)                                                       v1/messages#show {:format=>:json, :api_version=>1}
+                          PATCH  /api/v1/messages/:id(.:format)                                                       v1/messages#update {:format=>:json, :api_version=>1}
+                          PUT    /api/v1/messages/:id(.:format)                                                       v1/messages#update {:format=>:json, :api_version=>1}
+                          DELETE /api/v1/messages/:id(.:format)                                                       v1/messages#destroy {:format=>:json, :api_version=>1}
+           v2_message GET    /api/v2/messages/:id(.:format)                                                       v2/messages#show {:format=>:json, :api_version=>2}
+      read_v2_message POST   /api/v2/messages/:id/read(.:format)                                                  v1/messages#read {:format=>:json, :api_version=>1}
+          v2_messages GET    /api/v2/messages(.:format)                                                           v1/messages#index {:format=>:json, :api_version=>1}
+                          POST   /api/v2/messages(.:format)                                                           v1/messages#create {:format=>:json, :api_version=>1}
+                          PATCH  /api/v2/messages/:id(.:format)                                                       v1/messages#update {:format=>:json, :api_version=>1}
+                          PUT    /api/v2/messages/:id(.:format)                                                       v1/messages#update {:format=>:json, :api_version=>1}
+                          DELETE /api/v2/messages/:id(.:format)                                                       v1/messages#destroy {:format=>:json, :api_version=>1}
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/yasyf/versioned-routes-rails.
+

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+task default: :spec

data/bin/console

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

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'rubygems'
+require 'bundler'
+
+Bundler.require :default, :development
+
+Combustion.initialize! :all
+run Combustion::Application

data/lib/versioned_routes.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'versioned_routes/version'
+
+require 'versioned_routes/route_version_info'
+require 'versioned_routes/route_versions'
+
+require 'action_dispatch'
+
+ActionDispatch::Routing::RouteSet.prepend VersionedRoutes::RouteVersionInfo
+ActionDispatch::Routing::Mapper.prepend VersionedRoutes::RouteVersions

data/lib/versioned_routes/route_version_info.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'versioned_routes/versioned_routes_info'
+
+module VersionedRoutes
+  module RouteVersionInfo
+    attr_accessor :current_version_number
+
+    def clear!
+      reset_version_info!
+      super
+    end
+
+    def add_route(mapping, name)
+      return unless current_version.append mapping
+      super
+    end
+
+    def current_version
+      version_info[current_version_number || 1]
+    end
+
+    def version_info
+      @version_info || reset_version_info!
+    end
+
+    private
+
+    def reset_version_info!
+      @version_info = Hash.new { |h, k| h[k] = VersionedRoutesInfo.new(k) }
+    end
+  end
+end

data/lib/versioned_routes/route_versions.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module VersionedRoutes
+  module RouteVersions
+    def version(number, &block)
+      @set.current_version_number = number
+      @set.current_version.block = block
+
+      versions = @set
+                 .version_info
+                 .values
+                 .select { |info| info.number <= number }
+                 .sort_by(&:number)
+                 .reverse
+
+      scope path: "v#{number}", as: "v#{number}" do
+        versions.each do |info|
+          scope module: "v#{info.number}", defaults: { api_version: info.number } do
+            info.block.call if info.number <= number
+          end
+        end
+      end
+
+      @set.current_version_number = nil
+    end
+  end
+end

data/lib/versioned_routes/version.rb

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

data/lib/versioned_routes/versioned_routes_info.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module VersionedRoutes
+  class VersionedRoutesInfo
+    attr_accessor :number, :block, :paths
+
+    def initialize(number)
+      @number = number
+      @block = nil
+      @paths = Hash.new { |h, k| h[k] = Set.new }
+    end
+
+    def append(mapping)
+      verb = mapping.make_route(nil, nil).verb
+      regex = mapping.path.to_regexp
+      return false if paths[verb].include? regex
+      paths[verb] << regex
+      true
+    end
+  end
+end

data/versioned-routes-rails.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative 'lib/versioned_routes/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'versioned-routes-rails'
+  spec.version       = VersionedRoutes::VERSION
+  spec.authors       = ['Yasyf Mohamedali']
+  spec.email         = ['yasyfm@gmail.com']
+
+  spec.summary       = 'A simple DSL for versioned routes in Rails.'
+  spec.description   = '`versioned-routes-rails` adds a single method to the Rails `routes.rb` DSL,`version`, which allows you to specify API versions.'
+  spec.homepage      = 'https://github.com/yasyf/versioned-routes-rails'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/yasyf/versioned-routes-rails'
+
+  # 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{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'combustion', '~> 1.3'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec-rails'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'sqlite3'
+
+  spec.add_dependency 'actionpack'
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: versioned-routes-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yasyf Mohamedali
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-07-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: combustion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: rspec-rails
+  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: sqlite3
+  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: actionpack
+  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: "`versioned-routes-rails` adds a single method to the Rails `routes.rb`
+  DSL,`version`, which allows you to specify API versions."
+email:
+- yasyfm@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".byebug_history"
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config.ru
+- lib/versioned_routes.rb
+- lib/versioned_routes/route_version_info.rb
+- lib/versioned_routes/route_versions.rb
+- lib/versioned_routes/version.rb
+- lib/versioned_routes/versioned_routes_info.rb
+- versioned-routes-rails.gemspec
+homepage: https://github.com/yasyf/versioned-routes-rails
+licenses: []
+metadata:
+  homepage_uri: https://github.com/yasyf/versioned-routes-rails
+  source_code_uri: https://github.com/yasyf/versioned-routes-rails
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.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: A simple DSL for versioned routes in Rails.
+test_files: []