pry-diff-routes 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 157d8b346eea255e119daa75615fdad90a0f84db1c8b230ce818d63c8f475009
-  data.tar.gz: 35bef130d086c757eb1258b172c4967b81caa9077788682c34fa69ecfd3fbad7
+  metadata.gz: e7d4f70a20b3f099882df5459337ea0987e090bb1399add54f4bcbc4c7e506f8
+  data.tar.gz: '09b8bf9fdb81dc6fb00a132b9b6c2ab25e101bb14441b3d86eb0a8f0d10923bd'
 SHA512:
-  metadata.gz: af079cf685ccc01459969a02c4639ac895fb05eecb26e0e1269bfa7ffd53a15544ffaf160f1b3f5d1744757690f45f6f9e56ee2747b17f5a9b0fee60b0305b5f
-  data.tar.gz: c3665a9b0c549b4217c1216685fabb8c71876cc5b7d5f00bab5c028bbae0f5e0f7a0f10cad380b4c753e266a90c4e0fae9117e3a49969e117eb9ef801d19ed00
+  metadata.gz: 356b4ac8e6ba621c066b6ed24682075ab1afdbad4b179719dd2e4708f2a8c3dd7fbc35b7b61214ab90bec9ebda4d5f0e4dfe5dc793aacb39c15424e754310936
+  data.tar.gz: a154f819c891cb392cc2c57690db151d068f96f088e8644399a23925c1a3da94e6c578962bb52044c437e5459eff6ecd4ad32f76ee738402c2a906cf5d16a972

data/.github/workflows/pry-diff-routes.yml

@@ -0,0 +1,26 @@
+name: pry-diff-routes
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        ruby: [2.5, 2.6, 2.7]
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: Build and test with Rake
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        bundle exec rake

data/CHANGELOG.md

@@ -0,0 +1,25 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+
+## [Unreleased]
+### Added
+- Testing status badge
+- Github action for testing workflow
+- Demo screenshot to readme
+
+### Fixed
+- Constraints indentation on modified routes formatting
+- Modern hash format on modified routes formatting
+
+
+## [0.1.0] - 2020-03-21
+### Added
+- `diff-routes --removed`
+- `diff-routes --modified`
+- `diff-routes --new`
+- `diff-routes --save`
+
+
+[Unreleased]: https://github.com/styd/pry-diff-routes/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/styd/pry-diff-routes/releases/tag/v0.1.0

data/README.md

@@ -1,44 +1,59 @@
-# PryDiffRoutes
+# PryDiffRoutes ![pry-diff-routes](https://github.com/styd/pry-diff-routes/workflows/pry-diff-routes/badge.svg?branch=master)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/pry/diff/routes`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+> Inspect routes changes in Rails console.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'pry-diff-routes'
+gem 'pry-diff-routes', group: :development
 ```
 
-And then execute:
+## Usage
+### Flags
+
+A route is considered the same route if it maintains its verb (http method, e.g. `GET`, `POST`,
+etc.) and uri path. When its other properties are changed, we call it a modified route.
 
-    $ bundle install
+#### `-R` or `--removed`
 
-Or install it yourself as:
+Show removed routes only.
 
-    $ gem install pry-diff-routes
+#### `-M` or `--modified`
 
-## Usage
+Show modified routes only.
+
+#### `-N` or `--new`
+
+Show new routes only.
+
+#### `-S` or `--save`
 
-TODO: Write usage instructions here
+Make current routes as the basis for changes.
 
-## Development
+You can combine `-R`, `-M`, and `-N` together, but not `-S`.
 
-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.
+### Demo Screenshot
 
-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).
+![pry-diff-routes demo screenshot](/images/demo-screenshot.gif)
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/styd/pry-diff-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/[USERNAME]/pry-diff-routes/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/styd/pry-diff-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/styd/pry-diff-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).
+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 Pry::Diff::Routes project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/styd/pry-diff-routes/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Pry::Diff::Routes project's codebases, issue trackers, chat rooms
+and mailing lists is expected to follow the
+[code of conduct](https://github.com/styd/pry-diff-routes/blob/master/CODE_OF_CONDUCT.md).

data/lib/pry_diff_routes/formatters/modified_routes_formatter.rb

@@ -61,7 +61,7 @@ module PryDiffRoutes
 
     def constraints_changes(before, after)
       if before.constraints != after.constraints
-        <<-DIFF.chomp
+        pad_lines <<~DIFF.chomp, 2
           #{arrow_key('Constraints')}-#{highlight_red before.constraints}
                         +#{highlight_green after.constraints}
         DIFF

data/lib/pry_diff_routes/modern_hash_format.rb

@@ -0,0 +1,8 @@
+module PryDiffRoutes::ModernHashFormat
+  refine Hash do
+    alias old_to_s to_s
+    def to_s
+      old_to_s.gsub(%r{\:(\w+)\=\>}, "\\1: ")
+    end
+  end
+end

data/lib/pry_diff_routes/route_wrapper.rb

@@ -1,19 +1,11 @@
 require 'action_dispatch/routing/inspector'
 require_relative 'util'
-
-if RUBY_ENGINE == 'ruby'
-  using Module.new {
-    refine Hash do
-      alias old_to_s to_s
-      def to_s
-        old_to_s.gsub(%r{\:(\w+)\=\>}, "\\1: ")
-      end
-    end
-  }
-end
+require_relative 'modern_hash_format'
 
 module PryDiffRoutes
   class RouteWrapper < ActionDispatch::Routing::RouteWrapper
+    using ModernHashFormat if RUBY_ENGINE == 'ruby'
+
     include Util
     include Comparable
 

data/lib/pry_diff_routes/util.rb

@@ -1,5 +1,9 @@
+require_relative 'modern_hash_format'
+
 module PryDiffRoutes
   module Util
+    using ModernHashFormat if RUBY_ENGINE == 'ruby'
+
     module_function
 
     def pad_lines(text="", pad_length=0)

data/lib/pry_diff_routes/version.rb

@@ -1,3 +1,3 @@
 module PryDiffRoutes
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pry-diff-routes
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Adrian Setyadi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-21 00:00:00.000000000 Z
+date: 2020-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -73,8 +73,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/pry-diff-routes.yml"
 - ".gitignore"
 - ".rspec"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -82,12 +84,14 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- images/demo-screenshot.gif
 - lib/pry-diff-routes.rb
 - lib/pry_diff_routes/commands.rb
 - lib/pry_diff_routes/commands/diff_routes.rb
 - lib/pry_diff_routes/formatters/modified_routes_formatter.rb
 - lib/pry_diff_routes/formatters/new_routes_formatter.rb
 - lib/pry_diff_routes/formatters/removed_routes_formatter.rb
+- lib/pry_diff_routes/modern_hash_format.rb
 - lib/pry_diff_routes/railtie.rb
 - lib/pry_diff_routes/route_wrapper.rb
 - lib/pry_diff_routes/routes_diff_processor.rb
@@ -113,7 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Inspect routes changes in Rails console