namespacer-rb 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f9e088f3da0c2cad086dfb7db0d1f87a0085c7a6ec05cc6c86d27803aae2f369
+  data.tar.gz: 18dedbee30ad393da78a51b023969c70ba15ef1f0014442f180830164ae5786e
+SHA512:
+  metadata.gz: 109892aa660e213db391314c4d751e9cfec65c0ac10eb2f35e66a7d6baef074438e0e86c609be626f01790107c9cb2a2875776d3698bacd321ff2911fe0c960c
+  data.tar.gz: f71e3f361d1ce1ad9d552b1d4fbcefbdd44609b9bedba272d6ba9befbd6bb749c31fe0ccdeaef01c8e5bed28cb394e2e402e0bb469da6edd85ce059bc7bc47da

data/.rubocop.yml

@@ -0,0 +1,18 @@
+---
+require:
+  - rubocop-minitest
+  - rubocop-rake
+  - rubocop-performance
+
+AllCops:
+  TargetRubyVersion: 3.3
+  NewCops: enable
+
+Style/StringLiterals:
+  Enabled: true
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-04-10
+
+- Initial release

data/README.md

@@ -0,0 +1,31 @@
+# Namespacer
+
+TODO: Delete this and the text below, and describe your gem
+
+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/namespacer`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. 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 the created tag, 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/[USERNAME]/namespacer.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'minitest/test_task'
+
+Minitest::TestTask.create
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/exe/namespacer

@@ -0,0 +1,111 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'namespacer'
+require 'optparse'
+require 'pathname'
+require 'tty-command'
+module Rubyists
+  # Namespace for the namespacer CLI
+  module Namespacer
+    CliOptions = Struct.new(:recursive, :verbose, :in_place)
+    def self.cli_options
+      @cli_options ||= CliOptions.new(verbose: false, recursive: false, in_place: false)
+    end
+
+    def self.cmd
+      @cmd = TTY::Command.new
+    end
+  end
+end
+
+options = Rubyists::Namespacer.cli_options
+
+parser = OptionParser.new do |opts|
+  opts.banner = 'Usage: namespacer [options] NAMESPACE PATHS'
+
+  opts.on('-r', '--recursive', 'Recursively namespace all files in PATH') { |_| options.recursive = true }
+
+  opts.on('-i', '--in-place', 'Modify files in-place') { |_| options.in_place = true }
+
+  opts.on('-v', '--verbose', 'Verbose output') do
+    options.verbose = true
+  end
+end
+parser.parse!
+
+namespace, paths = ARGV
+
+if namespace.nil?
+  warn 'No namespace supplied'
+  warn parser
+  exit 1
+end
+
+if paths.nil?
+  warn 'No paths supplied'
+  warn parser
+  exit 2
+end
+paths = Array(paths) unless paths.is_a?(Array)
+
+paths.map! do |path|
+  p = Pathname(path)
+  unless p.exist?
+    warn "Path #{p} does not exist"
+    exit 3
+  end
+  unless options.recursive || p.file?
+    warn "Path #{p} is not a file (use -r to recursively namespace files)"
+    exit 4
+  end
+  p
+end
+
+def new_path(path)
+  dir = path.dirname
+  ext = path.extname
+  base = path.basename(ext.to_s)
+  dir.join("#{base}.namespaced#{ext}")
+end
+
+def namespace_file(namespace, path) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+  namespaced = Rubyists::Namespacer.namespace!(path.read, namespace)
+  write_path = Rubyists::Namespacer.cli_options.in_place ? path : new_path(path)
+  if Rubyists::Namespacer.cli_options.verbose
+    msg = "Namespacing #{write_path} with #{namespace}"
+    msg << ' (in-place)' if Rubyists::Namespacer.cli_options.in_place
+    warn msg
+  end
+  cmd = Rubyists::Namespacer.cmd.run(:rubocop,
+                                     '-A',
+                                     '--stdin',
+                                     write_path.basename.to_s,
+                                     '--stderr',
+                                     input: namespaced,
+                                     only_output_on_error: true)
+  write_path.write(cmd.out)
+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
+      warn "Path #{path} is a directory, use -r to recursively namespace files"
+      exit 5
+    end
+  when ->(p) { p.file? }
+    namespace_file(namespace, path)
+  else
+    raise 'Invalid path'
+  end
+end

data/lib/namespacer/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Rubyists
+  module Namespacer
+    VERSION = '0.1.2'
+  end
+end

data/lib/namespacer.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require_relative 'namespacer/version'
+require 'parser/current'
+require 'unparser'
+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
+  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
+
+    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
+      parser = Parser::CurrentRuby.new
+      rewriter = Rubyists::Namespacer::Rewriter.new namespaces
+      rewriter.rewrite(buffer, parser.parse(buffer))
+    end
+  end
+end
+
+if $PROGRAM_NAME == __FILE__
+  warn 'Wrapping myself'
+  puts Rubyists::Namespacer.namespace!(File.read(__FILE__), 'Rubyists::Namespacer')
+end

data/namespacer.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative 'lib/namespacer/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'namespacer-rb'
+  spec.version = Rubyists::Namespacer::VERSION
+  spec.authors = ['Tj (bougyman) Vanderpoel']
+  spec.email = ['tj@rubyists.com']
+
+  spec.summary = 'Namespace classes and modules in existing ruby source code.'
+  spec.description = 'For those times you realize you should have namespaced your class(es) or module(s).'
+  spec.homepage = 'https://github.com/rubyists/namespacer'
+  spec.required_ruby_version = '~> 3.3'
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = File.join(spec.homepage, '/blob/main/CHANGELOG.md')
+
+  # 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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .github appveyor Gemfile])
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency 'parser', '~> 3'
+  spec.add_dependency 'tty-command', '~> 0.10'
+  spec.add_dependency 'unparser', '~> 0.6'
+  spec.metadata['rubygems_mfa_required'] = 'true'
+end

data/sig/namespacer.rbs

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

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: namespacer-rb
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Tj (bougyman) Vanderpoel
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-04-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: tty-command
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: unparser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+description: For those times you realize you should have namespaced your class(es)
+  or module(s).
+email:
+- tj@rubyists.com
+executables:
+- namespacer
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- README.md
+- Rakefile
+- exe/namespacer
+- lib/namespacer.rb
+- lib/namespacer/version.rb
+- namespacer.gemspec
+- sig/namespacer.rbs
+homepage: https://github.com/rubyists/namespacer
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/rubyists/namespacer
+  source_code_uri: https://github.com/rubyists/namespacer
+  changelog_uri: https://github.com/rubyists/namespacer/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '3.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: Namespace classes and modules in existing ruby source code.
+test_files: []