namespacer-rb 0.1.7 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80c1319eb56d8321d3acacca45c0e724378f49c287f3447f22a709d3c8dfebec
-  data.tar.gz: 7b0c82bb2371409a298fd90bdbb15b655ca7e113600448cdd62a4a0a19ae80f1
+  metadata.gz: 799712754c8eb33dc80bd4abe91dd6e238ef49ccdc3b34c439f2b65a75c75aff
+  data.tar.gz: 8f69c56fcc7e24e4033ea0d6a7d62f7bb82b695fa94c1c22017e40ff89c1ffc8
 SHA512:
-  metadata.gz: 7a8679263fad4f27695766449de5f6a01c0111bbea1f818607ed3c1565d219b88da75469fe6ffc1e4fe2dad7d352b7c4fbb5e09d0e30c50e1640b7ad7a8bf81c
-  data.tar.gz: b0e8bb9897e55062169f119fb7a684ab6549cdc3a085b1bcb61d2b88b9869a9cd2e26f9d6b44142316f36ae09990c0ef0b59e476b72b72902961f0d39e85081d
+  metadata.gz: 0b56ad847515db054a56c39b7c3b00d558a6a68e580cccccc4cf1d714e79004d13b46a7a83004fda9f42077ef026fe20fc39266d99bf20df6a0ae66bf57b4ed4
+  data.tar.gz: 3f9835a59451fd0dddfbf915b5ad2707a8b0cc616ace9ccda04a007c2080c86f3e74dc4fd6472757e06c5987eb021802b5fd0f528e1930c083a5464384337d83

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)
+    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,12 @@ 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
+
   opts.on('-f', '--fail-rubocop-silently', 'Write files even if they are not rubocop-friendly') do |_|
     options.fail_rubocop_silently = true
   end
@@ -80,7 +87,7 @@ def new_path(path)
   dir = path.dirname
   ext = path.extname
   base = path.basename(ext.to_s)
-  dir.join("#{base}.namespaced#{ext}")
+  dir.join("#{base}_namespaced#{ext}")
 end
 
 def rubocop_cmd(path, ruby_code) # rubocop:disable Metrics/MethodLength
@@ -104,11 +111,13 @@ def rubocop_cmd(path, ruby_code) # rubocop:disable Metrics/MethodLength
 end
 
 def rubocop_friendly?(path)
+  opts = Rubyists::Namespacer.cli_options
   magic = Rubyists::Namespacer.magic
   mime = magic.file(path.to_s)
   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 Rubyists::Namespacer.cli_options.verbose
+  warn "File #{path} is not a Ruby file (#{mime}), consider -a" if opts.verbose
   false
 end
 
@@ -121,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)
@@ -133,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.7'
+    VERSION = '0.1.9'
   end
 end

data/lib/namespacer.rb

@@ -7,43 +7,16 @@ require 'pry'
 
 # Top-level namespace to keep Rubyists namespaces in isolation
 module Rubyists
-  # Wrap some namespace around top-level AST nodes of 'module' or 'class' type
+  # Namespace for the namespacer tool
   module Namespacer
-    # Do the 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
-
+    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
@@ -56,5 +29,5 @@ end
 
 if $PROGRAM_NAME == __FILE__
   warn 'Wrapping myself'
-  puts Rubyists::Namespacer.namespace!(File.read(__FILE__), 'Rubyists::Namespacer')
+  puts Rubyists::Namespacer.namespace!(File.read(__FILE__), 'Wrapped::Smoke::Test')
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: namespacer-rb
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.9
 platform: ruby
 authors:
 - Tj (bougyman) Vanderpoel
@@ -95,8 +95,8 @@ files:
 - 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