space2underscore 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '09dc850870dd86b0335f6b5e3ca1e4d7b80af677'
-  data.tar.gz: 4d33ef051ac1a64ebbeeeff3502998bfc138db59
+  metadata.gz: 47e87d5fef3cbf63b644d8718f6b5b4a6ac600b8
+  data.tar.gz: 3b93e888a49904995689e2eeacc17f552aacfc86
 SHA512:
-  metadata.gz: 5963793b19ee2a4fb18384ca387a4a555db2ab6e35bfa5e1e0eaae77e10f456556e804fb4c1d9ca56f1c9c78b2ff4bc08aad46dca7cd3c22d8b30513e19355e0
-  data.tar.gz: bc9f85ad75a939cb5165c11c48f5c004dae21709aec5d401d20ba5c0cf47dbdeee328a17ebc789f5fad1633bc0cb1f7952fffb4d1c4086905aecc1f44715d3b2
+  metadata.gz: 8044f50d77379b6c448c545e34a5d80d4939bd40b1527d34b5d50d45c4e794cd64334cd14ab78a1d270014392b33a3761cc01a59116203aeaac18e4e63884233
+  data.tar.gz: 0f6dc1b4eae1536a67a9ee18fce5e8e666cfe09c7f68f3e63a797ec3bed32ed6522fd2f4cd8ae3e36cb7d73aa9c817bdf0dfb06aeefbdbe2515ceef023717dd9

data/.gitignore

@@ -3,7 +3,6 @@
 .bundle
 .config
 .yardoc
-Gemfile.lock
 InstalledFiles
 _yardoc
 coverage
@@ -16,3 +15,4 @@ test/tmp
 test/version_tmp
 tmp
 /vendor
+Gemfile.lock

data/.rubocop.yml

@@ -3,3 +3,6 @@ AllCops:
 
   Exclude:
     - 'vendor/bundle/**/*'
+
+Style/Documentation:
+  Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Space2underscore Change Log
 
+## v0.5.2
+- Refactor methods in space2underscore.
+- Refactor examples for space2underscore.
+- Add an option for raw.
+
+### Security Changes
+- Lock the RuboCop version over `0.49.0`.
+
+## v0.5.1
+- Fix a bug where failed to print usage.
+
 ## v0.5.0
 - Add a task for tagging
 - Add tests for bins

data/README.md

@@ -19,7 +19,7 @@ From the command line:
 ### 1. e.g. Create the new branch
 
 ```
-$ space2underscore new branch -c
+$ s2u new branch -c
 =>  Switched to a new branch 'new_branch’
 ```
 
@@ -28,18 +28,11 @@ Run with `--create` or `-c` options.
 ### 2. e.g. Rename the already created a branch
 
 ```
-$ git branch -m $(space2underscore renamed branch)
+$ git branch -m $(s2u renamed branch)
 ```
 
-When option is nothing, space2underscore has outputted to the standard output.
-
-## Shorthand
-
-A shorthand alias for space2underscore can also be used.
-
-```
-s2u new branch
-```
+## !! Cation !!
+This is a command line tool. So DO NOT include all modules because it uses `system` command. So crackers will be attacking your application.
 
 ## Credits
 - Help information based on [@motemen's ghq](https://github.com/motemen/ghq)

data/bin/s2u

@@ -2,21 +2,5 @@
 # frozen_string_literal: true
 
 require 'space2underscore'
-require 'pry'
 
-CREATE_FLAGS = %w(-c --create).freeze
-
-args = ARGV.reject { |arg| CREATE_FLAGS.include?(arg) }
-convert_flag = ARGV.select { |arg| CREATE_FLAGS.include?(arg) }
-underscore_include_sentence = Space2underscore.convert(args)
-
-if ARGV.empty?
-  puts Space2underscore.usage
-  exit
-end
-
-if convert_flag.empty?
-  puts underscore_include_sentence
-else
-  Space2underscore.create_new_branch(underscore_include_sentence)
-end
+Space2underscore::Cli.new(ARGV).start

data/bin/space2underscore

@@ -2,21 +2,5 @@
 # frozen_string_literal: true
 
 require 'space2underscore'
-require 'pry'
 
-CREATE_FLAGS = %w(-c --create).freeze
-
-args = ARGV.reject { |arg| CREATE_FLAGS.include?(arg) }
-convert_flag = ARGV.select { |arg| CREATE_FLAGS.include?(arg) }
-underscore_include_sentence = Space2underscore.convert(args)
-
-if ARGV.empty?
-  puts Space2underscore.usage
-  exit
-end
-
-if convert_flag.empty?
-  puts underscore_include_sentence
-else
-  Space2underscore.create_new_branch(underscore_include_sentence)
-end
+Space2underscore::Cli.new(ARGV).start

data/lib/space2underscore.rb

@@ -1,37 +1,13 @@
 # frozen_string_literal: true
 
-require 'space2underscore/version'
-
 # This is the main functions.
 module Space2underscore
-  MESSAGE = <<-EOF.chomp
-      NAME:
-         space2underscore - Change the space into underscore
-
-      USAGE:
-         $ space2underscore new branch -c
-         =>  Switched to the new branch 'new_branch’
-
-        Or
-
-        $ git branch -m $(space2underscore renamed branch)
-
-      VERSION:
-         #{Space2underscore::VERSION}
-
-      OPTIONS:
-         --create, -c         create a new branch
-  EOF
-
-  def self.convert(argv)
-    argv.length == 1 ? argv[0].strip.gsub(/\s/, '_') : argv.join('_')
-  end
+end
 
-  def self.create_new_branch(underscore_include_sentence)
-    system "git checkout -b #{underscore_include_sentence}"
-  end
+require 'space2underscore/version'
 
-  def self.usage
-    MESSAGE.gsub('      ', '')
-  end
-end
+require 'space2underscore/executor'
+require 'space2underscore/printer'
+require 'space2underscore/underscore'
+require 'space2underscore/usage'
+require 'space2underscore/cli'

data/lib/space2underscore/cli.rb

@@ -0,0 +1,46 @@
+module Space2underscore
+  class Cli
+    CREATE_FLAGS = %w[-c --create].freeze
+    RAW_FLAGS = %w[-r --raw].freeze
+
+    FLAGS = [CREATE_FLAGS, RAW_FLAGS].flatten.freeze
+
+    OptionParseError = Class.new(ArgumentError)
+
+    def initialize(argv)
+      @argv = argv
+      @underscore_include_branch = Underscore.new(branch).convert
+    end
+
+    def start
+      $stdout.puts Usage.new.content && exit if @argv.empty?
+
+      case
+      when included?(CREATE_FLAGS) && included?(RAW_FLAGS)
+        Executor.new(@underscore_include_branch).run_with_raw
+      when included?(CREATE_FLAGS) && not_included?(RAW_FLAGS)
+        Executor.new(@underscore_include_branch).run_with_downcase
+      when not_included?(CREATE_FLAGS) && included?(RAW_FLAGS)
+        Printer.instance.run_with_raw(@underscore_include_branch)
+      when not_included?(CREATE_FLAGS) && not_included?(RAW_FLAGS)
+        Printer.instance.run_with_downcase(@underscore_include_branch)
+      else
+        raise OptionParseError, 'Option is invalid format. It is only avaliable for `-c --create -d --downcase`'
+      end
+    end
+
+    private
+
+    def branch
+      @argv.reject { |arg| FLAGS.include?(arg) }
+    end
+
+    def included?(flags)
+      @argv.any? { |arg| flags.include?(arg) }
+    end
+
+    def not_included?(flags)
+      !included?(flags)
+    end
+  end
+end

data/lib/space2underscore/executor.rb

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

data/lib/space2underscore/printer.rb

@@ -0,0 +1,21 @@
+require 'singleton'
+
+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

@@ -0,0 +1,15 @@
+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/lib/space2underscore/usage.rb

@@ -0,0 +1,26 @@
+module Space2underscore
+  class Usage
+    MESSAGE = <<-EOF.chomp
+        NAME:
+           space2underscore - Change the space into underscore
+
+        USAGE:
+           $ space2underscore new branch -c
+           =>  Switched to the new branch 'new_branch’
+
+          Or
+
+          $ git branch -m $(space2underscore renamed branch)
+
+        VERSION:
+           #{Space2underscore::VERSION}
+
+        OPTIONS:
+           --create, -c         create a new branch
+    EOF
+
+    def content
+      MESSAGE.gsub('        ', '')
+    end
+  end
+end

data/lib/space2underscore/version.rb

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

data/space2underscore.gemspec

@@ -21,9 +21,9 @@ Gem::Specification.new do |spec|
 
   spec.post_install_message = File.read('post_install_message.txt')
 
-  spec.add_development_dependency 'bundler', '~> 1.3'
+  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'
+  spec.add_development_dependency 'rubocop', '< 0.49.0'
 end

data/spec/space2underscore/printer_spec.rb

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

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

@@ -0,0 +1,10 @@
+# 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,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'bundler/setup'
 require 'space2underscore'
 
 if ENV['COVERALLS']

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: space2underscore
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - sachin21
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-21 00:00:00.000000000 Z
+date: 2017-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -70,16 +70,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.49.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.49.0
 description: Change the space into underscore
 email:
 - sachin21.developer@gmail.com
@@ -101,10 +101,17 @@ files:
 - bin/s2u
 - bin/space2underscore
 - lib/space2underscore.rb
+- lib/space2underscore/cli.rb
+- lib/space2underscore/executor.rb
+- lib/space2underscore/printer.rb
+- lib/space2underscore/underscore.rb
+- lib/space2underscore/usage.rb
 - lib/space2underscore/version.rb
 - post_install_message.txt
 - space2underscore.gemspec
-- spec/space2underscore_spec.rb
+- 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:
@@ -144,10 +151,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Change the space into underscore
 test_files:
-- spec/space2underscore_spec.rb
+- spec/space2underscore/printer_spec.rb
+- spec/space2underscore/underscore_spec.rb
+- spec/space2underscore/usage_spec.rb
 - spec/spec_helper.rb

data/spec/space2underscore_spec.rb

@@ -1,91 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-require 'open3'
-
-describe Space2underscore do
-  let(:branch_name) { 'foo_bar' }
-  let(:hidden) { '&> /dev/null' }
-
-  describe '.convert' do
-    it 'returns underscore included in string' do
-      expect(Space2underscore.convert(['foo bar'])).to include('_')
-      expect(Space2underscore.convert(%w(foo bar))).to include('_')
-    end
-  end
-
-  def checkout_master
-    execute_command('git checkout master')
-  end
-
-  def delete_branch
-    execute_command("git branch -D #{branch_name}")
-  end
-
-  def create_branch
-    execute_command("git branch #{branch_name}")
-  end
-
-  def execute_command(command)
-    system("#{command} #{hidden}")
-  end
-
-  describe '.create_new_branch' do
-    before do
-      checkout_master
-      delete_branch
-    end
-
-    after do
-      checkout_master
-      delete_branch
-    end
-
-    it 'creates the new branch' do
-      expect(Space2underscore.create_new_branch(branch_name)).to eq true
-    end
-  end
-
-  describe '.usage' do
-    it 'returns String class' do
-      expect(Space2underscore.usage).to be_a(String)
-    end
-
-    it 'does not return an blank string does' do
-      expect(Space2underscore.usage).not_to be_nil
-    end
-  end
-
-  describe 'bin' do
-    let(:argument1) { 'hoge' }
-    let(:argument2) { 'fuga' }
-    let(:result) { Open3.capture2(bin, argument1, argument2) }
-    subject(:output) { result[0] }
-    subject(:status) { result[1] }
-
-    shared_examples_for 'output' do
-      it 'returns underscore included in string' do
-        expect(output).to eq "hoge_fuga\n"
-      end
-    end
-
-    shared_examples_for 'status' do
-      it 'returns underscore included in string' do
-        expect(status.success?).to be true
-      end
-    end
-
-    context 'with Space2underscore' do
-      let(:bin) { File.join('bin', 's2u') }
-
-      it_behaves_like 'output'
-      it_behaves_like 'status'
-    end
-    context 'with s2u' do
-      let(:bin) { File.join('bin', 'space2underscore') }
-
-      it_behaves_like 'output'
-      it_behaves_like 'status'
-    end
-  end
-end