namespacer-rb 0.1.8 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9007d905c40b79426ef2e135e520bf0a87f035a2ae2413c06398d0e04d91f73
-  data.tar.gz: a43de5cd8ca7bde19071109dc171ee7b534647ff2d5c0729e15ad1b5410874f1
+  metadata.gz: af2aa4d4cbdf4fc10dba7f5af4baeece22091dd92f9da68abed73e574d48dff3
+  data.tar.gz: 1b142abdfe26c43b19e8957e2a2415d87f0b122568f72083a2212fe78ac5fa64
 SHA512:
-  metadata.gz: bafd3deefcd88b7c476aa295fc7d6134e7d0e0ca0589077a24fda966b401fd3a5f6e3832832092e24723f1ea63940113b28479e6322efdd9dcb94a00df79bc35
-  data.tar.gz: b47c888e929e11a25c6990a9578cd04c57d9da8250268a4787243013178b297f30b73bd0bb33faef05300df4e4eb249304f6b342a8984fe34809a34ce1b9e09c
+  metadata.gz: 8270dabf68e4ca29bd83012ec696d34c45197519e5c85dd2f279262a0806f70298ce492b02aaff682b93fbf86663247b8b35d2a0ed280259dabbf1d1b7c52c8c
+  data.tar.gz: 1bf580fcebfcc2a4982ab89a307e76f2aa7fd44506b4f3a34fdfe0bcb1cf391dd9f4eb2720f2261f176b39fcd8fcef6f67d41bb8db94d2d9f71973d6e2f3f91a

data/.overcommit.yml

@@ -0,0 +1,11 @@
+---
+PreCommit:
+  RuboCop:
+    enabled: true
+  BundleAudit:
+    enabled: true
+  BundleCheck:
+    enabled: true
+  BundleOutdated:
+    enabled: true
+

data/exe/namespacer

@@ -9,7 +9,8 @@ require 'tty-command'
 module Rubyists
   # Namespace for the namespacer CLI
   module Namespacer
-    CliOptions = Struct.new(:recursive, :verbose, :in_place, :fail_rubocop_silently, :allow_text_files)
+    CLI_OPTS = %i[recursive verbose in_place fail_rubocop_silently allow_text_files dry_run].freeze
+    CliOptions = Struct.new(*CLI_OPTS)
     def self.cli_options
       @cli_options ||= CliOptions.new(verbose: false, recursive: false, in_place: false)
     end
@@ -33,6 +34,8 @@ parser = OptionParser.new do |opts|
 
   opts.on('-i', '--in-place', 'Modify files in-place') { |_| options.in_place = true }
 
+  opts.on('-d', '--dry-run', 'Dry run, do not write files') { |_| options.dry_run = true }
+
   opts.on('-a', '--allow-text-files', 'Allow non-ruby mime types, so long as they are text') do |_|
     options.allow_text_files = true
   end
@@ -114,7 +117,7 @@ def rubocop_friendly?(path)
   return true if mime.include?('text/x-ruby')
   return true if mime.split('/').first == 'text' && opts.allow_text_files
 
-  warn "File #{path} is not a Ruby file (#{mime})" if opts.verbose
+  warn "File #{path} is not a Ruby file (#{mime}), consider -a" if opts.verbose
   false
 end
 
@@ -127,8 +130,12 @@ def log_namespace(namespace, write_path)
   warn msg
 end
 
+def valid_file?(path)
+  !excluded_path?(path) && rubocop_friendly?(path)
+end
+
 def namespace_file(namespace, path)
-  return unless rubocop_friendly?(path)
+  return unless valid_file?(path)
 
   opts = Rubyists::Namespacer.cli_options
   namespaced = Rubyists::Namespacer.namespace!(path.read, namespace)
@@ -139,16 +146,20 @@ def namespace_file(namespace, path)
   write_path.write(cmd.out)
 end
 
+def excluded_path?(path)
+  return true if path.directory?
+  return true if path.basename.to_s.start_with?('.')
+  return true if path.basename.to_s.end_with?('_namespaced')
+  return true if path.basename.to_s.match?(/_namespaced\.[^\.]+$/)
+
+  false
+end
+
 paths.each do |path|
   case path
   when ->(p) { p.directory? }
     if options.recursive
       path.find do |f|
-        next if f.directory?
-        next if f.basename.to_s.start_with?('.')
-        next if f.basename.to_s.end_with?('.namespaced')
-        next if f.basename.to_s.end_with?('.namespaced.rb')
-
         namespace_file(namespace, f)
       end
     else

data/lib/namespacer/rewriter.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Rubyists
+  module Namespacer
+    # Do the AST rewriting with the Rewriter class
+    class Rewriter < Parser::TreeRewriter
+      attr_accessor(:namespaces)
+
+      def initialize(namespaces)
+        super()
+        @namespaces = namespaces
+      end
+
+      def on_module(node)
+        _on_module(node)
+      end
+
+      def on_class(node)
+        _on_module(node)
+      end
+
+      private
+
+      def wrap(ast)
+        # Recursively wrap the AST in the namespace modules
+        namespaces.split('::').reverse.inject(ast) do |current_ast, ns|
+          # Create a module node with the current namespace part and the current AST
+          Parser::AST::Node.new(:module, [Parser::AST::Node.new(:const, [nil, ns.to_sym]), current_ast])
+        end
+      end
+
+      def _on_module(node)
+        return unless node.location.column.zero?
+
+        (ast, comments) = Unparser.parse_with_comments(node.location.expression.source)
+        replace(node.location.expression, Unparser.unparse(wrap(ast), comments))
+      end
+    end
+  end
+end

data/lib/namespacer/version.rb

@@ -2,6 +2,6 @@
 
 module Rubyists
   module Namespacer
-    VERSION = '0.1.8'
+    VERSION = '0.1.10'
   end
 end

data/lib/namespacer.rb

@@ -9,42 +9,14 @@ require 'pry'
 module Rubyists
   # Namespace for the namespacer tool
   module Namespacer
-    # Do the AST rewriting with the Rewriter class
-    class Rewriter < Parser::TreeRewriter
-      attr_accessor(:namespaces)
-
-      def initialize(namespaces)
-        super()
-        @namespaces = namespaces
-      end
-
-      def on_module(node)
-        _on_module(node)
-      end
-
-      def on_class(node)
-        _on_module(node)
-      end
-
-      private
-
-      def wrap(ast)
-        # Recursively wrap the AST in the namespace modules
-        namespaces.split('::').reverse.inject(ast) do |current_ast, ns|
-          # Create a module node with the current namespace part and the current AST
-          Parser::AST::Node.new(:module, [Parser::AST::Node.new(:const, [nil, ns.to_sym]), current_ast])
-        end
-      end
-
-      def _on_module(node)
-        return unless node.location.column.zero?
-
-        (ast, comments) = Unparser.parse_with_comments(node.location.expression.source)
-        replace(node.location.expression, Unparser.unparse(wrap(ast), comments))
-      end
-    end
-
-    # Wrap some namespace around top-level AST nodes of 'module' or 'class' type
+    require_relative 'namespacer/rewriter'
+
+    # Wrap some namespace(s) around top-level AST nodes of 'module' or 'class' type
+    #
+    # @param string_or_io [String, IO] The source code to namespace
+    # @param namespaces [String] The namespace(s) to wrap around the top-level AST nodes
+    #
+    # @return [String] The source code with the namespace(s) wrapped around the top-level AST nodes
     def self.namespace!(string_or_io, namespaces)
       buffer = Parser::Source::Buffer.new("(#{namespaces})")
       buffer.source = string_or_io.is_a?(IO) ? string_or_io.read : string_or_io

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: namespacer-rb
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.10
 platform: ruby
 authors:
 - Tj (bougyman) Vanderpoel
@@ -89,14 +89,15 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".overcommit.yml"
 - ".rubocop.yml"
 - CHANGELOG.md
 - Rakefile
 - Readme.adoc
 - exe/namespacer
 - lib/namespacer.rb
+- lib/namespacer/rewriter.rb
 - lib/namespacer/version.rb
-- sig/namespacer.rbs
 homepage: https://github.com/rubyists/namespacer
 licenses: []
 metadata:

data/sig/namespacer.rbs

@@ -1,4 +0,0 @@
-module Namespacer
-  VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-end