namespacer-rb 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9e088f3da0c2cad086dfb7db0d1f87a0085c7a6ec05cc6c86d27803aae2f369
-  data.tar.gz: 18dedbee30ad393da78a51b023969c70ba15ef1f0014442f180830164ae5786e
+  metadata.gz: a72519123e573f5919a27d3bf9f67d8058518b99d1132a60b98ac3399b8786a3
+  data.tar.gz: 1de535bf8f1731015d09305483673012c214d8aff07d1df2e350117ec9437b92
 SHA512:
-  metadata.gz: 109892aa660e213db391314c4d751e9cfec65c0ac10eb2f35e66a7d6baef074438e0e86c609be626f01790107c9cb2a2875776d3698bacd321ff2911fe0c960c
-  data.tar.gz: f71e3f361d1ce1ad9d552b1d4fbcefbdd44609b9bedba272d6ba9befbd6bb749c31fe0ccdeaef01c8e5bed28cb394e2e402e0bb469da6edd85ce059bc7bc47da
+  metadata.gz: 64be7577c8da68f66f5dd9d709abad8150e2260f3ac68b7a74b40b117605f396c7437b2498f5d2218e5ecc5ef87967a9eddb31aeeb57bf5282f36951716faca4
+  data.tar.gz: 758fd04be5835101752fdb695962e153f7e55ecbe3a3e34a253a6e905c453f2ff00986ecd6b3ccb6dc005bdb36a7c1dbaa3d84e9e9159146dbb0ea40a9388679

data/Readme.adoc

@@ -0,0 +1,39 @@
+# Namespacer
+:ifdef::env-github[]
+:tip-caption: :bulb:
+:note-caption: :information_source:
+:important-caption: :heavy_exclamation_mark:
+:caution-caption: :fire:
+:warning-caption: :warning:
+endif::[]
+
+This gem is a simple library to namespace your classes and modules in Ruby. It is useful when you want to avoid naming conflicts between different libraries or parts of your application.
+
+An executable is included to help you namespace your project files.
+
+## Installation
+
+[source,sh]
+----
+gem install namespacer-rb
+----
+
+## Usage
+
+`namespacer --help` will show you the available options.
+
+### Namespacing a file
+
+`namespacer MyNamespace my_file.rb` will create a new file `my_file.namespaced.rb` with all top-level classes and modules namespaced under `MyNamespace`.
+
+## 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` (`gem bump` can do this), and then run `bundle exec rake release`.
+This will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to https://rubygems.org[rubygems.org].
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rubyists/namespacer.

data/lib/namespacer/version.rb

@@ -2,6 +2,6 @@
 
 module Rubyists
   module Namespacer
-    VERSION = '0.1.2'
+    VERSION = '0.1.3'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: namespacer-rb
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Tj (bougyman) Vanderpoel
@@ -63,12 +63,11 @@ extra_rdoc_files: []
 files:
 - ".rubocop.yml"
 - CHANGELOG.md
-- README.md
 - Rakefile
+- Readme.adoc
 - exe/namespacer
 - lib/namespacer.rb
 - lib/namespacer/version.rb
-- namespacer.gemspec
 - sig/namespacer.rbs
 homepage: https://github.com/rubyists/namespacer
 licenses: []

data/README.md

@@ -1,31 +0,0 @@
-# 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/namespacer.gemspec

@@ -1,39 +0,0 @@
-# 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