sexp_cli_tools 0.2.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a21d6577d3a220cb12efdef4b6970bfffe3d6d3340d5b393ef8eb2d5d1d8dfb
-  data.tar.gz: 11fd4fa3451304911ad84a1c6b33ce02b030ec879cbd018bed2bca2d658021ed
+  metadata.gz: 4a1dd5f9fed467c4a1d34ce7235494718afec4ffa1321abe3ff5d1c6ec36ea0c
+  data.tar.gz: 8c4bbf0cf2404e8ff508bb18b83423daf0a5a137aaa4716a63a38afc66054427
 SHA512:
-  metadata.gz: bffcd6efc339b795493e50ec77b352f0c311a00cd9ccaeb2c45be175e2159da3908beb61265789fbf5b147a40bd4a19f82f9da6fe323b1552502dba2f9338835
-  data.tar.gz: 265bd475057f625df3480af2aae8d7c01c4cb964ce1bbdacdd06e17d651b2e790c942dbd7db6267c98302e1e5ff4983f8459561f8bfa2dd35a8b85d64485a8f4
+  metadata.gz: dc57297a5aa2d4b9ab1b93e69f09c34f65b7c0a8fe86e14f7eeb2b1178cd0bc7bc7abd6fdd0c65db5d7d4de39baa0810cf7fee70ba4df08bc831a07cc6c9d414
+  data.tar.gz: 367f2ef084b22883e87314e3f2b37594069f8224ea0c75329dff99634dacbb5d1cf43e6583258f23b013b5f6d6a63a050eacc346a69fe735de1a1a9a160c3554

data/.ruby-version

@@ -0,0 +1 @@
+3.0.2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sexp_cli_tools (0.2.1)
+    sexp_cli_tools (1.0.0)
       ruby_parser (~> 3.18.1)
       thor (~> 1.1.0)
 

data/README.md

@@ -91,7 +91,7 @@ The `sexp` command offers a convenient shortcut to the `Sexp::Matcher` expressio
 
 ##### Iterating on figuring out `Sexp::Matcher` patterns
 
-What isn't show in [the commit which added the `Sexp::Matcher`](https://github.com/cpb/sexp_cli_tools/commit/34db6012b03f705b1d9c23025d3636fbf9d801dd) is the trial and error in the console trying to remember the terse rules.
+What isn't shown in [the commit which added the `Sexp::Matcher`](https://github.com/cpb/sexp_cli_tools/commit/34db6012b03f705b1d9c23025d3636fbf9d801dd) is the trial and error in the console trying to remember the terse rules.
 
 Setting up a unit test can help close that iteration loop. [Consider the unit test for `SexpCliTools::Matchers::SuperCaller`](test/sexp_cli_tools/matchers/super_caller_test.rb)
 
@@ -101,6 +101,35 @@ Allowing users to experiment with s-expressions might enable exploration and dis
 - `sexp find '[child (class ___)]'` to find class definitions nested in a namespace
 - `sexp find '[child (case ___)]'` to find case statements
 
+So having test driven the development of [the `super-caller` matcher](lib/sexp_cli_tools/matchers/super_caller.rb) next we have to find the methods that respond to `super`.
+
+##### Finding super implementations
+
+So far we've been using `Sexp::Matcher` strings to find quite abstract parts of our code. But, it's completely possible to fill in what in the parts we know that we'd like to find.
+
+- `sexp find '(class :Bicycle ___)'` from my working copy of this project turns up the [test fixture file for `Bicycle`](https://github.com/cpb/sexp_cli_tools/blob/eb6ebe8722cd13cc91ba12bc69380e09c3bdfe0d/test/fixtures/coupling_between_superclasses_and_subclasses/bicycle.rb), as well as the copy of it `aruba` makes in the `tmp/` directory for testing purposes.
+- `sexp find '[child (defn :initialize ___)]'` only turns up the [test fixture file for `RoadBike`](https://github.com/cpb/sexp_cli_tools/blob/eb6ebe8722cd13cc91ba12bc69380e09c3bdfe0d/test/fixtures/coupling_between_superclasses_and_subclasses/test/fixtures/coupling_between_superclasses_and_subclasses/road_bike.rb). I guess it is time to fill in more of our `Bicycle` class!
+
+Finding the super implementation will involve finding a class that contains a method defintion. So far, our matchers haven't taken any parameters. A (naive) matcher for a super implementation might have two parameters, the name of the class we expect to define the method, and the name of the method.
+
+##### Passing matcher parameters
+
+Early on I chose to have the second sequence argument to the command line interface `sexp find` the glob pattern of files to include in the search. However, I want to prioritize matcher parameters for that position now. Although my test coverage didn't include tests for that glob pattern, I did document it.
+
+So, when I [moved that out into the `--include` command line option](https://github.com/cpb/sexp_cli_tools/pull/12/commits/af66f0b7da549426ee0b6444f46b317da279e9a0), that was a breaking change to the public interface. That would necessitate incrementing the major version number according to semantic versioning. I have a hunch that because I'm still in the `0` major release, I could get away with not bumping it. But, I think the `--include` is something I can stick to.
+
+What I remember about semantic versioning is that additions can just be minor version bumps. So, as long as I don't make a backwards incompatible change to the `find` command or the `--include` option I should be good.
+
+Following merge of: [✨ `sexp find method-implementation passed_method` lists files that define the passed method](https://github.com/cpb/sexp_cli_tools/pull/12) I'll release `v1.0.0`! In that PR I chose to do inside-out testing because the `aruba` tests are a bit slow.
+
+I found it helpful to run just the CLI command tests I was working on using the `TEST` and `TESTOPTS` options to the `rake` test tast, like so:
+
+```shell
+rake TEST='test/sexp_cli_tools/cli_test.rb' TESTOPTS="--name=/method-implementation/"
+```
+
+##### Capturing the Superclass name
+
 #### Hook methods from super callers
 
 #### Hook calls from super methods

data/lib/sexp_cli_tools/cli.rb

@@ -8,11 +8,13 @@ module SexpCliTools
       puts "SexpCliTools version: %p" % SexpCliTools::VERSION
     end
 
-    desc "find sexp-matcher [**/*.rb]", "Finds Ruby files matching the s-expression matcher in the glob pattern. Defaults to search all Ruby files with the pattern **/*.rb"
-    def find(requested_sexp_matcher, glob="**/*.rb")
+    option :include, default: '**/*.rb'
+    desc "find sexp-matcher [--include='**/*.rb']", "Finds Ruby files matching the s-expression matcher in the glob pattern. Defaults to search all Ruby files with the pattern **/*.rb"
+    def find(requested_sexp_matcher, *matcher_params)
+      glob = options[:include]
       sexp_matcher = SexpCliTools::MATCHERS[requested_sexp_matcher]
       Pathname.glob(glob).each do |path|
-        puts path.to_s if sexp_matcher.satisfy?(RubyParser.new.parse(path.read))
+        puts path.to_s if sexp_matcher.satisfy?(RubyParser.new.parse(path.read), *matcher_params)
       end
     end
   end

data/lib/sexp_cli_tools/matchers/method_implementation.rb

@@ -0,0 +1,17 @@
+module SexpCliTools
+  module Matchers
+    class MethodImplementation
+      def self.satisfy?(sexp, target_method)
+        new(target_method).satisfy?(sexp)
+      end
+
+      def initialize(target_method)
+        @matcher = Sexp::Matcher.parse("[child (defn #{target_method} ___)]")
+      end
+
+      def satisfy?(sexp)
+        @matcher.satisfy?(sexp)
+      end
+    end
+  end
+end

data/lib/sexp_cli_tools/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SexpCliTools
-  VERSION = "0.2.1"
+  VERSION = "1.0.0"
 end

data/lib/sexp_cli_tools.rb

@@ -4,6 +4,7 @@ require "ruby_parser"
 
 require_relative "sexp_cli_tools/version"
 require_relative "sexp_cli_tools/matchers/super_caller"
+require_relative "sexp_cli_tools/matchers/method_implementation"
 
 module SexpCliTools
   class Error < StandardError; end
@@ -14,5 +15,6 @@ module SexpCliTools
       "child-class" => Sexp::Matcher.parse('(class _ (const _) ___)'),
       "parent-class" => Sexp::Matcher.parse('(class _ [not? (const _)] ___)'),
       "super-caller" => Matchers::SuperCaller,
+      "method-implementation" => Matchers::MethodImplementation,
     })
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sexp_cli_tools
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Caleb Buxton
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-17 00:00:00.000000000 Z
+date: 2021-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby_parser
@@ -47,6 +47,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".ruby-version"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -59,6 +60,7 @@ files:
 - exe/sexp
 - lib/sexp_cli_tools.rb
 - lib/sexp_cli_tools/cli.rb
+- lib/sexp_cli_tools/matchers/method_implementation.rb
 - lib/sexp_cli_tools/matchers/super_caller.rb
 - lib/sexp_cli_tools/version.rb
 - sexp_cli_tools.gemspec