space2underscore 0.5.3 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5405706c2105ac418843695f1d7afd044b9564ed685af0c6f8fa154553eb206e
-  data.tar.gz: 706848adbf574a43e1d99627e00e09fbd207e504dd516b25ccbea5e62f71d69e
+  metadata.gz: dba1ba27849c81429c896976c2b3b0cc958742f16dc5f0588280aeca3f1a9ddb
+  data.tar.gz: 5fb0b0dba5cf58ac7b61e4f3309e700780d3f07f2b1848da33cc5d9163bc09e2
 SHA512:
-  metadata.gz: 868566a30e93b631a124e6493f9b7016db45975097ce2c0d6aa17bc14b420208d31dc84bdeea91fe96084117c3a6025576f214782aedbf21668266471d4f9ce3
-  data.tar.gz: a19420ddb6a53121649889f839f537a793193ffddea28e8b84706c110287de23f40c2f5ed14141cf405eaacfd37a68d24881f51f57d8f55737b918f29db7cd73
+  metadata.gz: a2694fe66f5dc84dbe708eea7fcc14f56b6e5828ba92f860663a1aae5fed6e8133f617827bc72fc9b8a73340ba69dfb4b759404037a368584f5391cd9828fe67
+  data.tar.gz: 9887708fc1716e3d71cd3395b3ce7fe2b61a7b8e189d26d571e95515118fe85e067daec0d39b8504eeeb130512dbc9be463d4df4df1b7ed5eca91662e4c1a964

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Space2underscore Change Log
 
+## v0.6.1
+- Bump minimum Ruby version to 2.7.
+- Migrate from Travis CI to GitHub Actions.
+- Modernize gem specification.
+- Update RuboCop configuration with modern settings.
+- Remove version constraint from Coveralls.
+- Improve README with clearer structure and formatting.
+
+## v0.6.0
+- Fix command injection vulnerability in Executor.
+- Simplify architecture and remove Singleton pattern.
+- Replace duplicate s2u with symlink.
+- Add project configuration file.
+- Fix typos in documentation.
+
 ## v0.5.2
 - Refactor methods in space2underscore.
 - Refactor examples for space2underscore.

data/README.md

@@ -1,15 +1,19 @@
 # Space2underscore
 
-![Gem Version](https://badge.fury.io/rb/space2underscore.svg) [![Build Status](https://travis-ci.org/sachin21/space2underscore.svg?branch=master)](https://travis-ci.org/sachin21/space2underscore) [![Code Climate](https://codeclimate.com/github/sachin21/space2underscore/badges/gpa.svg)](https://codeclimate.com/github/sachin21/space2underscore) [![Coverage Status](https://coveralls.io/repos/sachin21/space2underscore/badge.svg?branch=master&service=github)](https://coveralls.io/github/sachin21/space2underscore?branch=master) [![Gem](https://img.shields.io/gem/dt/space2underscore.svg)](https://rubygems.org/gems/space2underscore)
+A CLI tool that converts spaces into underscores. Useful for creating or renaming Git branches.
 
-## What is space2underscore
+[![Gem Version](https://badge.fury.io/rb/space2underscore.svg)](https://badge.fury.io/rb/space2underscore)
+[![CI](https://github.com/sachin21/space2underscore/workflows/CI/badge.svg)](https://github.com/sachin21/space2underscore/actions)
+[![Code Climate](https://codeclimate.com/github/sachin21/space2underscore/badges/gpa.svg)](https://codeclimate.com/github/sachin21/space2underscore)
+[![Coverage Status](https://coveralls.io/repos/sachin21/space2underscore/badge.svg?branch=master&service=github)](https://coveralls.io/github/sachin21/space2underscore?branch=master)
+[![Gem Downloads](https://img.shields.io/gem/dt/space2underscore.svg)](https://rubygems.org/gems/space2underscore)
 
-Change the space into underscore.
-space2underscore is a useful command when you want to check out a branch.
+## Requirements
 
-## Installation
+- Ruby >= 2.4.0
+- Git
 
-Install it yourself as:
+## Installation
 
 ```
 $ gem install space2underscore
@@ -17,28 +21,52 @@ $ gem install space2underscore
 
 ## Usage
 
-From the command line:
+### Create a new branch
 
-### 1. e.g. Create the new branch
+Use the `-c` (`--create`) option to create a new Git branch with spaces converted to underscores.
 
 ```
 $ s2u new branch -c
-=>  Switched to a new branch 'new_branch’
+=> Switched to a new branch 'new_branch'
 ```
 
-Run with `--create` or `-c` options.
+### Rename an existing branch
 
-### 2. e.g. Rename the already created a branch
+Use `$(s2u ...)` as a subcommand.
 
 ```
 $ git branch -m $(s2u renamed branch)
 ```
 
-## !! Cation !!
+### Print the converted string
+
+Without any options, the converted string is printed to stdout. By default, the output is downcased.
+
+```
+$ s2u Hello World
+hello_world
+```
+
+### Preserve original case
+
+Use the `-r` (`--raw`) option to keep the original letter casing.
+
+```
+$ s2u Hello World -r
+Hello_World
+```
+
+### Options
+
+| Option | Short | Description |
+|---|---|---|
+| `--create` | `-c` | Create a new Git branch with the converted name |
+| `--raw` | `-r` | Preserve original letter casing (skip downcase) |
+
+## Caution
+
+This is a command line tool. **DO NOT** include this module in other Ruby applications, as it uses the `system` command internally, which may introduce command injection vulnerabilities.
 
-This is a command line tool. So DO NOT include space2underscore's module in other Ruby application because it uses `system` command.
-If you include this module to your application, there is a possibility of crackers attacking.
+## License
 
-## Credits
-- Help information based on [@motemen's ghq](https://github.com/motemen/ghq)
-- Installed information based on [Tmuxinator](https://github.com/tmuxinator/tmuxinator)
+[MIT License](MIT-LICENSE) - Copyright (c) 2014 Satoshi Ohmori

data/bin/s2u

@@ -0,0 +1 @@
+space2underscore

data/lib/space2underscore/branch_creator.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Space2underscore
+  # Creates git branches with secure command execution
+  class BranchCreator
+    class << self
+      # Create a new git branch with the given name
+      #
+      # @param name [String] Branch name to create
+      # @return [void]
+      # @raise [SystemExit] Exits with git command status code
+      def create(name)
+        # Use array form to prevent command injection
+        # Place branch name directly after -b as git requires,
+        # then -- to separate from any start-point ambiguity
+        exit system('git', 'checkout', '-b', name, '--')
+      end
+    end
+  end
+end

data/lib/space2underscore/cli.rb

@@ -1,67 +1,40 @@
 # frozen_string_literal: true
 
 module Space2underscore
+  # Main CLI orchestrator
   class Cli
-    CREATE_FLAGS = %w[-c --create].freeze
-    RAW_FLAGS = %w[-r --raw].freeze
-
-    FLAGS = [CREATE_FLAGS, RAW_FLAGS].flatten.freeze
-
-    ERROR_MSG = 'Option is invalid format. It is only avaliable for `-c --create -d --downcase`'
-
-    OptionParseError = Class.new(ArgumentError)
-
     def initialize(argv)
       @argv = argv
-      @underscore_include_branch = Underscore.new(branch).convert
-      @executer = Executor.instance
-      @printer  = Printer.instance
     end
 
     def start
-      return $stdout.puts Usage.new.content if @argv.empty?
+      options = OptionsParser.parse(@argv)
 
-      if with_all_flags?
-        @executer.run_with_raw(@underscore_include_branch)
-      elsif create_flags_without_raw_flags?
-        @executer.run_with_downcase(@underscore_include_branch)
-      elsif raw_flags_without_create_flags?
-        @printer.run_with_raw(@underscore_include_branch)
-      elsif without_any_flags?
-        @printer.run_with_downcase(@underscore_include_branch)
-      else
-        raise OptionParseError, ERROR_MSG
-      end
-    end
+      # Show usage if no arguments
+      return display_usage unless options
 
-    private
+      # Convert input to branch name
+      branch_name = Converter.convert(options.input)
 
-    def branch
-      @argv.reject { |arg| FLAGS.include?(arg) }
-    end
+      # Apply case transformation
+      branch_name = branch_name.downcase if options.downcase
 
-    def included?(flags)
-      @argv.any? { |arg| flags.include?(arg) }
-    end
-
-    def not_included?(flags)
-      !included?(flags)
-    end
-
-    def without_any_flags?
-      not_included?(CREATE_FLAGS) && not_included?(RAW_FLAGS)
-    end
-
-    def with_all_flags?
-      included?(CREATE_FLAGS) && included?(RAW_FLAGS)
+      # Execute action
+      case options.action
+      when :create
+        BranchCreator.create(branch_name)
+      when :print
+        OutputPrinter.print(branch_name)
+      end
+    rescue OptionsParser::ParseError => e
+      $stderr.puts "Error: #{e.message}"
+      exit 1
     end
 
-    def create_flags_without_raw_flags?
-      included?(CREATE_FLAGS) && not_included?(RAW_FLAGS)
-    end
+    private
 
-    def raw_flags_without_create_flags?
-      included?(RAW_FLAGS) && not_included?(CREATE_FLAGS)
+    def display_usage
+      $stdout.puts Usage.new.content
     end
   end
 end

data/lib/space2underscore/converter.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Space2underscore
+  # Converts spaces to underscores in branch names
+  class Converter
+    class << self
+      # Convert input to branch name with underscores
+      #
+      # @param input [Array<String>] Input words
+      # @return [String] Branch name with underscores
+      def convert(input)
+        return '' if input.empty?
+
+        if input.length == 1
+          # Single argument: "foo bar" -> "foo_bar"
+          input[0].strip.gsub(/\s+/, '_')
+        else
+          # Multiple arguments: ["foo", "bar"] -> "foo_bar"
+          input.join('_')
+        end
+      end
+    end
+  end
+end

data/lib/space2underscore/options_parser.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Space2underscore
+  # Represents parsed command-line options
+  Options = Struct.new(:action, :input, :downcase, keyword_init: true)
+
+  # Parses command-line arguments into Options
+  class OptionsParser
+    CREATE_FLAGS = %w[-c --create].freeze
+    RAW_FLAGS = %w[-r --raw].freeze
+    ALL_FLAGS = (CREATE_FLAGS + RAW_FLAGS).freeze
+
+    ParseError = Class.new(ArgumentError)
+
+    class << self
+      # Parse argv into Options object
+      #
+      # @param argv [Array<String>] Command-line arguments
+      # @return [Options, nil] Parsed options or nil if empty
+      # @raise [ParseError] If arguments are invalid
+      def parse(argv)
+        return nil if argv.empty? # Triggers usage display
+
+        has_create = argv.any? { |arg| CREATE_FLAGS.include?(arg) }
+        has_raw = argv.any? { |arg| RAW_FLAGS.include?(arg) }
+        input = argv.reject { |arg| ALL_FLAGS.include?(arg) }
+
+        validate_input!(input)
+
+        Options.new(
+          action: has_create ? :create : :print,
+          input: input,
+          downcase: !has_raw # raw flag means preserve case
+        )
+      end
+
+      private
+
+      def validate_input!(input)
+        raise ParseError, 'Branch name is required' if input.empty?
+      end
+    end
+  end
+end

data/lib/space2underscore/output_printer.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Space2underscore
+  # Prints branch names to stdout
+  class OutputPrinter
+    class << self
+      # Print branch name to stdout
+      #
+      # @param name [String] Branch name to print
+      # @return [void]
+      def print(name)
+        $stdout.puts name
+      end
+    end
+  end
+end

data/lib/space2underscore/version.rb

@@ -2,5 +2,5 @@
 
 # This module holds the Space2underscore version information.
 module Space2underscore
-  VERSION = '0.5.3'
+  VERSION = '0.6.1'
 end

data/lib/space2underscore.rb

@@ -7,8 +7,9 @@ end
 require 'singleton'
 
 require 'space2underscore/version'
-require 'space2underscore/executor'
-require 'space2underscore/printer'
-require 'space2underscore/underscore'
+require 'space2underscore/options_parser'
+require 'space2underscore/converter'
+require 'space2underscore/output_printer'
+require 'space2underscore/branch_creator'
 require 'space2underscore/usage'
 require 'space2underscore/cli'

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: space2underscore
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.6.1
 platform: ruby
 authors:
 - sachin21
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-11 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -70,16 +69,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.49.0
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.49.0
+        version: '1.0'
 description: Change the space into underscore
 email:
 - sachin21dev@gmail.com
@@ -89,34 +88,26 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
-- Gemfile
 - MIT-LICENSE
 - README.md
-- Rakefile
 - bin/s2u
 - bin/space2underscore
 - lib/space2underscore.rb
+- lib/space2underscore/branch_creator.rb
 - lib/space2underscore/cli.rb
-- lib/space2underscore/executor.rb
-- lib/space2underscore/printer.rb
-- lib/space2underscore/underscore.rb
+- lib/space2underscore/converter.rb
+- lib/space2underscore/options_parser.rb
+- lib/space2underscore/output_printer.rb
 - lib/space2underscore/usage.rb
 - lib/space2underscore/version.rb
 - post_install_message.txt
-- space2underscore.gemspec
-- spec/space2underscore/printer_spec.rb
-- spec/space2underscore/underscore_spec.rb
-- spec/space2underscore/usage_spec.rb
-- spec/spec_helper.rb
 homepage: https://github.com/sachin21/space2underscore
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/sachin21/space2underscore/issues
+  source_code_uri: https://github.com/sachin21/space2underscore
 post_install_message: |
   ..........................................................
   __________________________________________________________
@@ -143,20 +134,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 4.0.4
 specification_version: 4
 summary: Change the space into underscore
-test_files:
-- spec/space2underscore/printer_spec.rb
-- spec/space2underscore/underscore_spec.rb
-- spec/space2underscore/usage_spec.rb
-- spec/spec_helper.rb
+test_files: []

data/.gitignore

@@ -1,18 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-/vendor
-Gemfile.lock

data/.rspec

@@ -1,2 +0,0 @@
---color
---format progress

data/.rubocop.yml

@@ -1,16 +0,0 @@
-AllCops:
-  TargetRubyVersion: 2.3
-
-  Exclude:
-    - 'vendor/bundle/**/*'
-
-  DisplayCopNames: true
-
-Style/Documentation:
-  Enabled: false
-
-Metrics/LineLength:
-  Max: 100
-
-Metrics/MethodLength:
-  Max: 15

data/.travis.yml

@@ -1,17 +0,0 @@
-language: ruby
-
-rvm:
-  - 2.3.7
-  - 2.4.4
-  - 2.5.1
-  - ruby-head
-
-before_install:
-  - gem install bundler
-  - rm -f .git/index.lock
-
-script: "bundle exec rake spec:with_coveralls"
-
-notifications:
-  email: false
-  slack: sachin21dev:3pEyff2UFnoCgl4NI0uxbsER

data/Gemfile

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-gemspec
-
-gem 'coveralls', '0.8.3', require: false

data/Rakefile

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-
-gem_helper = Bundler::GemHelper.new
-
-desc "Create tag #{gem_helper.send(:version_tag)}"
-task :tag do
-  gem_helper.send(:tag_version) unless gem_helper.send(:already_tagged?)
-end
-
-task default: :spec
-
-namespace :spec do
-  desc 'Run RSpec with Coveralls'
-  task :with_coveralls do
-    ENV['COVERALLS'] = 'true'
-    Rake::Task['spec'].execute
-  end
-end

data/bin/s2u

@@ -1,6 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require 'space2underscore'
-
-Space2underscore::Cli.new(ARGV).start

data/lib/space2underscore/executor.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module Space2underscore
-  class Executor
-    include Singleton
-
-    def run_with_raw(underscore_include_sentence)
-      run underscore_include_sentence
-    end
-
-    def run_with_downcase(underscore_include_sentence)
-      run underscore_include_sentence.downcase
-    end
-
-    private
-
-    def run(sentence)
-      exit system "git checkout -b #{sentence}"
-    end
-  end
-end

data/lib/space2underscore/printer.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module Space2underscore
-  class Printer
-    include Singleton
-
-    def run_with_raw(branch)
-      run branch
-    end
-
-    def run_with_downcase(branch)
-      run branch.downcase
-    end
-
-    private
-
-    def run(branch)
-      $stdout.puts branch
-    end
-  end
-end

data/lib/space2underscore/underscore.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module Space2underscore
-  class Underscore
-    def initialize(sentence)
-      @sentence = sentence
-    end
-
-    def convert
-      if @sentence.length == 1
-        @sentence[0].strip.gsub(/\s/, '_')
-      else
-        @sentence.join('_')
-      end
-    end
-  end
-end

data/space2underscore.gemspec

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'space2underscore/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'space2underscore'
-  spec.version       = Space2underscore::VERSION
-  spec.authors       = ['sachin21']
-  spec.email         = ['sachin21dev@gmail.com']
-  spec.description   = 'Change the space into underscore'
-  spec.summary       = 'Change the space into underscore'
-  spec.homepage      = 'https://github.com/sachin21/space2underscore'
-  spec.license       = 'MIT'
-
-  spec.files         = `git ls-files`.split($RS)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ['lib']
-  spec.required_ruby_version = '>= 2.3.0'
-
-  spec.post_install_message = File.read('post_install_message.txt')
-
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'rubocop', '< 0.49.0'
-end

data/spec/space2underscore/printer_spec.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe Space2underscore::Printer do
-  let(:branch) { 'FOO_bar' }
-
-  describe '#run_with_raw' do
-    subject { -> { described_class.instance.run_with_raw(branch) } }
-
-    it { is_expected.to output(/FOO_bar/).to_stdout }
-  end
-
-  describe '#run_with_downcase' do
-    subject { -> { described_class.instance.run_with_downcase(branch) } }
-
-    it { is_expected.to output(/foo_bar/).to_stdout }
-  end
-end

data/spec/space2underscore/underscore_spec.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-require 'open3'
-
-describe Space2underscore::Underscore do
-  describe '#convert' do
-    subject { described_class.new(argument).convert }
-
-    context 'when number of argument is one' do
-      let(:argument) { ['foo bar'] }
-
-      it { is_expected.to include('_') }
-    end
-
-    context 'when number of argument is many' do
-      let(:argument) { %w[foo bar] }
-
-      it { is_expected.to include('_') }
-    end
-  end
-end

data/spec/space2underscore/usage_spec.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe Space2underscore::Usage do
-  subject { described_class.new.content }
-
-  it { is_expected.to be_a String }
-  it { is_expected.not_to be_empty }
-end

data/spec/spec_helper.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-require 'space2underscore'
-
-if ENV['COVERALLS']
-  require 'coveralls'
-  Coveralls.wear!
-end
-
-Bundler.setup
-
-RSpec.configure do |config|
-  config.order = 'random'
-  config.expect_with :rspec do |rspec|
-    rspec.syntax = :expect
-  end
-end