basehangul 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5dea832635fe4ba4c9cb0e698175e776ebc273ce
-  data.tar.gz: af201548ca14b381e7cad53b6674acb988b87c79
+  metadata.gz: 1f556466ab0b3e2d7eda2d4331d0f5bd467ed8a9
+  data.tar.gz: b71091f342d216e95534be3fef902043f8324b1c
 SHA512:
-  metadata.gz: 9e02f9167a48cb7a28c3328a2a216d5b2f6ca084312c9c3df2aff4f505137139348e3295dcc857962cd9fbb62a1aab3c77e1c8b0ea3f86254bd1894b67091cd4
-  data.tar.gz: f09e00ca1d6d6745ca3ad7e511d25de23174906243e1117739feac6def022317293ebdc1449f288811cf1f85d32fad12889faa9ab6dda2ac254b0f164b1d2056
+  metadata.gz: 9608d251910fe633fa334437bdc826fb19f081bb02838bc3ac20f0df242073d0aa6f9c7ba4cd98025e8b1f6066b0f86a50d95a185904f166d7d1c1dddf416e43
+  data.tar.gz: 9f95afa048a10db337d0b1dc91cbee4f3b8822f495ba739a833828e57301692cba754fd2c4736f83d2714d08278d96c2b908b70d7c1296fc755fa7c09ffaed87

data/.rubocop_todo.yml

@@ -1,15 +1,10 @@
 # This configuration was generated by `rubocop --auto-gen-config`
-# on 2014-11-08 01:14:38 +0900 using RuboCop version 0.27.0.
+# on 2014-11-10 01:37:53 +0900 using RuboCop version 0.27.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 3
-Metrics/AbcSize:
-  Max: 21
-
 # Offense count: 1
-# Configuration parameters: CountComments.
-Metrics/MethodLength:
-  Max: 15
+Metrics/AbcSize:
+  Max: 19

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.2.0 (2014-11-12)
+
+- Implement CLI of BaseHangul
+
 ## 1.1.0 (2014-11-08)
 
 - Make `BaseHangul.decode` to ignore invalid characters

data/README.md

@@ -39,6 +39,42 @@ BaseHangul.decode('넥라똔먈늴멥갯놓궂뗐밸뮤뉴뗐뀄굡덜멂똑뚤'
 # => 'This is an encoded string'
 ```
 
+Run `basehangul` with no arguments to encode binary through terminal input.
+
+``` sh
+basehangul
+```
+
+Or pass `basehangul` a file to encode.
+
+``` sh
+basehangul binary.txt
+```
+
+Run `basehangul` with no arguments to decode BaseHangul string through terminal input.
+
+``` sh
+basehangul -D
+```
+
+Or pass `basehangul` a file to decode.
+
+``` sh
+basehangul -D basehangul.txt
+```
+
+For additional command-line options:
+
+``` sh
+basehangul -h
+```
+
+Command flag    | Description
+----------------|--------------------
+`-D, --decode`  | Decode the input.
+`-h, --help`    | Print this message.
+`-v, --version` | Print version.
+
 ## Contributing
 
 1. Fork it (https://github.com/yous/basehangul/fork)

data/bin/basehangul

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+$LOAD_PATH.unshift(File.expand_path('../../lib', File.realpath(__FILE__)))
+require 'basehangul'
+
+cli = BaseHangul::CLI.new
+exit cli.run

data/lib/basehangul.rb

@@ -2,6 +2,8 @@
 
 require 'basehangul/version'
 require 'basehangul/utils'
+require 'basehangul/option'
+require 'basehangul/cli'
 
 # Human-readable binary encoding.
 module BaseHangul
@@ -46,15 +48,7 @@ module BaseHangul
   #
   # Returns the String decoded binary.
   def self.decode(str)
-    indices = str.each_char.map { |ch| Utils.to_index(ch) }
-    binary = indices.map do |index|
-      case index
-      when 0..1023    then index.to_s(2).rjust(10, '0')
-      when 1024..1027 then (index - 1024).to_s(2).rjust(2, '0')
-      end
-    end.join
-    binary = binary[0..-(binary.size % 8 + 1)]
-    [binary].pack('B*')
+    Utils.decode_indices(str.each_char.map { |ch| Utils.to_index(ch) })
   end
 
   # Public: Decode BaseHangul string.
@@ -71,13 +65,6 @@ module BaseHangul
       indices << index
     end
     fail ArgumentError, MSG_INVALID_PADDING unless str =~ REGEX_BASEHANGUL
-    binary = indices.map do |index|
-      case index
-      when 0..1023    then index.to_s(2).rjust(10, '0')
-      when 1024..1027 then (index - 1024).to_s(2).rjust(2, '0')
-      end
-    end.join
-    binary = binary[0..-(binary.size % 8 + 1)]
-    [binary].pack('B*')
+    Utils.decode_indices(indices)
   end
 end

data/lib/basehangul/cli.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+
+module BaseHangul
+  # Handle command line interfaces logic.
+  class CLI
+    # Initialize a CLI.
+    def initialize
+      @options = {}
+    end
+
+    # Entry point for the application logic. Process command line arguments and
+    # run the BaseHangul.
+    #
+    # args - An Array of Strings user passed.
+    #
+    # Returns an Integer UNIX exit code.
+    def run(args = ARGV)
+      @options, paths = Option.new.parse(args)
+      source = paths.empty? ? $stdin.read : IO.read(paths[0])
+      if @options[:decode]
+        puts BaseHangul.decode(source)
+      else
+        puts BaseHangul.encode(source)
+      end
+      0
+    end
+  end
+end

data/lib/basehangul/option.rb

@@ -0,0 +1,59 @@
+# encoding: utf-8
+
+require 'optparse'
+
+module BaseHangul
+  # Handle command line options.
+  class Option
+    # Initialize a Option.
+    def initialize
+      @options = {}
+    end
+
+    # Parse the passed arguments to a Hash.
+    #
+    # args - An Array of Strings containing options.
+    #
+    # Returns an Array containing a Hash options and an Array of Strings
+    #   remaining arguments.
+    def parse(args)
+      OptionParser.new do |opts|
+        opts.banner = 'Usage: basehangul [options] [source]'
+
+        add_options(opts)
+        add_options_on_tail(opts)
+      end.parse!(args)
+      [@options, args]
+    end
+
+    private
+
+    # Add command line options.
+    #
+    # opts - An OptionParser object to add options.
+    #
+    # Returns nothing.
+    def add_options(opts)
+      opts.on('-D', '--decode', 'Decode the input.') do
+        @options[:decode] = true
+      end
+    end
+
+    # Add command line options printed at tail.
+    #
+    # opts - An OptionParser object to add options.
+    #
+    # Returns nothing.
+    def add_options_on_tail(opts)
+      opts.on_tail('-h', '--help', 'Print this message.') do
+        puts opts
+        exit 0
+      end
+
+      opts.on_tail('-v', '--version', 'Print version.') do
+        puts Version::STRING
+        exit 0
+      end
+    end
+  end
+end

data/lib/basehangul/utils.rb

@@ -58,6 +58,25 @@ module BaseHangul
         .encode(Encoding::UTF_8)
     end
 
+    # Convert BaseHangul indices to hangul string.
+    #
+    # Examples
+    #
+    #   decode_indices([196, -1, -1, -1])
+    #   # => '꺽흐흐흐'
+    #
+    # Returns the String decoded binary.
+    def self.decode_indices(indices)
+      binary = indices.map do |index|
+        case index
+        when 0..1023    then index.to_s(2).rjust(10, '0')
+        when 1024..1027 then (index - 1024).to_s(2).rjust(2, '0')
+        end
+      end.join
+      binary = binary[0..-(binary.size % 8 + 1)]
+      [binary].pack('B*')
+    end
+
     # Slice a string into chunks of a given size.
     #
     # str  - The String to slice.

data/lib/basehangul/version.rb

@@ -3,6 +3,6 @@
 module BaseHangul
   # Holds the BaseHangul version information.
   module Version
-    STRING = '1.1.0'
+    STRING = '1.2.0'
   end
 end

data/spec/basehangul/cli_spec.rb

@@ -0,0 +1,55 @@
+# encoding: utf-8
+
+RSpec.describe BaseHangul::CLI do
+  include FileHelper
+  include_context 'isolated environment'
+
+  subject(:cli) { described_class.new }
+
+  before(:example) { $stdout = StringIO.new }
+  after(:example) { $stdout = STDOUT }
+
+  it 'encodes text file passed as an argument' do
+    create_file('binary.txt',
+                'ABCDE' \
+                '12345' \
+                '가나다라마' \
+                "\u3000")
+    expect(cli.run(['binary.txt'])).to be(0)
+    expect($stdout.string)
+      .to eq("꿸거껫경꺽먹께겔법많겡밌뙨렷륑꽥뜰봤륑밖밞갑가흐\n")
+  end
+
+  it 'encodes string passed as an stdin argument' do
+    allow($stdin).to receive(:read).once
+      .and_return('ABCDE' \
+                  '12345' \
+                  '가나다라마' \
+                  "\u3000")
+    expect(cli.run([])).to be(0)
+    expect($stdout.string)
+      .to eq("꿸거껫경꺽먹께겔법많겡밌뙨렷륑꽥뜰봤륑밖밞갑가흐\n")
+  end
+
+  describe '-D/--decode' do
+    it 'decodes text file passed as an argument' do
+      create_file('basehangul.txt',
+                  ['꿸거껫경꺽먹께겔법많겡밌뙨렷륑꽥뜰봤륑밖밞갑가흐'])
+      expect(cli.run(['--decode', 'basehangul.txt'])).to be(0)
+      expect($stdout.string).to eq('ABCDE' \
+                                   '12345' \
+                                   '가나다라마' \
+                                   "\u3000\n")
+    end
+
+    it 'decodes string passed as an stdin argument' do
+      allow($stdin).to receive(:read).once
+        .and_return('꿸거껫경꺽먹께겔법많겡밌뙨렷륑꽥뜰봤륑밖밞갑가흐')
+      expect(cli.run(['--decode'])).to be(0)
+      expect($stdout.string) .to eq('ABCDE' \
+                                    '12345' \
+                                    '가나다라마' \
+                                    "\u3000\n")
+    end
+  end
+end

data/spec/basehangul/option_spec.rb

@@ -0,0 +1,43 @@
+# encoding: utf-8
+
+RSpec.describe BaseHangul::Option do
+  include ExitCodeMatchers
+
+  subject(:option) { described_class.new }
+
+  before(:example) { $stdout = StringIO.new }
+  after(:example) { $stdout = STDOUT }
+
+  describe 'option' do
+    describe '-h/--help' do
+      it 'exits cleanly' do
+        expect { option.parse(['-h']) }.to exit_with_code(0)
+        expect { option.parse(['--help']) }.to exit_with_code(0)
+      end
+
+      it 'shows help text' do
+        begin
+          option.parse(['--help'])
+        rescue SystemExit # rubocop:disable Lint/HandleExceptions
+        end
+
+        expected_help = <<-END
+Usage: basehangul [options] [source]
+    -D, --decode                     Decode the input.
+    -h, --help                       Print this message.
+    -v, --version                    Print version.
+        END
+
+        expect($stdout.string).to eq(expected_help)
+      end
+    end
+
+    describe '-v/--version' do
+      it 'exits cleanly' do
+        expect { option.parse(['-v']) }.to exit_with_code(0)
+        expect { option.parse(['--version']) }.to exit_with_code(0)
+        expect($stdout.string).to eq("#{BaseHangul::Version::STRING}\n" * 2)
+      end
+    end
+  end
+end

data/spec/basehangul/utils_spec.rb

@@ -51,6 +51,62 @@ RSpec.describe BaseHangul::Utils do
     end
   end
 
+  describe '.decode_indices' do
+    it 'returns empty string for empty array' do
+      decoded = utils.decode_indices([])
+      expect(decoded).to eq('')
+    end
+
+    context 'when there is no padding indices' do
+      it 'decodes indices to binary' do
+        decoded = utils.decode_indices([196, 803, 216, 354])
+        expect(decoded).to eq('123ab')
+        decoded = utils.decode_indices([196, 803, 217, 0])
+        expect(decoded).to eq("123d\x00")
+        decoded = utils.decode_indices([196, 803, 205, 53, 216, 883, 526, 304])
+        expect(decoded).to eq('1234567890')
+        decoded = utils.decode_indices([196, 803, 205, 53, 216, 883, 537, 0])
+        expect(decoded).to eq("12345678d\x00")
+      end
+    end
+
+    context 'when there are padding characters' do
+      it 'decodes indices to binary' do
+        decoded = utils.decode_indices([196, -1, -1, -1])
+        expect(decoded).to eq('1')
+        decoded = utils.decode_indices([196, 800, -1, -1])
+        expect(decoded).to eq('12')
+        decoded = utils.decode_indices([196, 803, 192, -1])
+        expect(decoded).to eq('123')
+        decoded = utils.decode_indices([196, 803, 205, 53, 216, 880, -1, -1])
+        expect(decoded).to eq('1234567')
+        decoded = utils.decode_indices([196, 803, 205, 53, 216, 883, 512, -1])
+        expect(decoded).to eq('12345678')
+      end
+    end
+
+    context 'when there are special characters' do
+      it 'decodes indices to binary' do
+        decoded = utils.decode_indices([196, 803, 217, 1024])
+        expect(decoded).to eq('123d')
+        decoded = utils.decode_indices([196, 803, 217, 1025])
+        expect(decoded).to eq('123e')
+        decoded = utils.decode_indices([196, 803, 217, 1026])
+        expect(decoded).to eq('123f')
+        decoded = utils.decode_indices([196, 803, 217, 1027])
+        expect(decoded).to eq('123g')
+        decoded = utils.decode_indices([196, 803, 205, 53, 216, 883, 537, 1024])
+        expect(decoded).to eq('12345678d')
+        decoded = utils.decode_indices([196, 803, 205, 53, 216, 883, 537, 1025])
+        expect(decoded).to eq('12345678e')
+        decoded = utils.decode_indices([196, 803, 205, 53, 216, 883, 537, 1026])
+        expect(decoded).to eq('12345678f')
+        decoded = utils.decode_indices([196, 803, 205, 53, 216, 883, 537, 1027])
+        expect(decoded).to eq('12345678g')
+      end
+    end
+  end
+
   describe '.chunks' do
     context 'with empty string' do
       it 'returns an empty array' do

data/spec/support/exit_code_matchers.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+
+# Matches exit code of block with SystemExit.
+module ExitCodeMatchers
+  RSpec::Matchers.define :exit_with_code do |code|
+    supports_block_expectations
+    actual = nil
+    match do |block|
+      begin
+        block.call
+      rescue SystemExit => e
+        actual = e.status
+      end
+      actual && actual == code
+    end
+    failure_message do
+      "expected block to call exit(#{code}) but exit" +
+        (actual.nil? ? ' not called' : "(#{actual}) was called")
+    end
+    failure_message_when_negated do
+      "expected block not to call exit(#{code})"
+    end
+    description do
+      "expect block to call exit(#{code})"
+    end
+  end
+end

data/spec/support/file_helper.rb

@@ -0,0 +1,39 @@
+# encoding: utf-8
+
+require 'fileutils'
+
+# Util methods for processing file.
+module FileHelper
+  # Create file with at given path with given content. Ensure parent directories
+  # are exists.
+  #
+  # path    - An String path of file.
+  # content - An String or an Array of Strings content of file.
+  #
+  # Returns nothing.
+  def create_file(path, content)
+    file_path = File.expand_path(path)
+    dir_path = File.dirname(file_path)
+    FileUtils.makedirs(dir_path) unless File.exist?(dir_path)
+    write_file(path, content)
+  end
+
+  # Write file content at given path.
+  #
+  # path    - An String path of file.
+  # content - An String or an Array of Strings content of file.
+  #
+  # Returns nothing.
+  def write_file(path, content)
+    File.open(path, 'w') do |file|
+      case content
+      when ''
+        # Create empty file.
+      when String
+        file.write(content)
+      when Array
+        file.puts(content.join("\n"))
+      end
+    end
+  end
+end

data/spec/support/isolated_environment.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+
+require 'tmpdir'
+
+RSpec.shared_context 'isolated environment' do
+  around do |example|
+    Dir.mktmpdir do |tmpdir|
+      tmpdir = File.realpath(tmpdir)
+      Dir.chdir(tmpdir) do
+        example.run
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: basehangul
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - ChaYoung You
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-07 00:00:00.000000000 Z
+date: 2014-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -83,7 +83,8 @@ dependencies:
 description: Human-readable binary encoding, BaseHangul for Ruby.
 email:
 - yousbe@gmail.com
-executables: []
+executables:
+- basehangul
 extensions: []
 extra_rdoc_files: []
 files:
@@ -98,14 +99,22 @@ files:
 - README.md
 - Rakefile
 - basehangul.gemspec
+- bin/basehangul
 - lib/basehangul.rb
+- lib/basehangul/cli.rb
+- lib/basehangul/option.rb
 - lib/basehangul/utils.rb
 - lib/basehangul/version.rb
+- spec/basehangul/cli_spec.rb
+- spec/basehangul/option_spec.rb
 - spec/basehangul/utils_spec.rb
 - spec/basehangul/version_spec.rb
 - spec/basehangul_spec.rb
 - spec/spec_helper.rb
 - spec/support/coverage.rb
+- spec/support/exit_code_matchers.rb
+- spec/support/file_helper.rb
+- spec/support/isolated_environment.rb
 - spec/support/shared_decode.rb
 homepage: ''
 licenses:
@@ -132,9 +141,14 @@ signing_key:
 specification_version: 4
 summary: Human-readable binary encoding, BaseHangul for Ruby.
 test_files:
+- spec/basehangul/cli_spec.rb
+- spec/basehangul/option_spec.rb
 - spec/basehangul/utils_spec.rb
 - spec/basehangul/version_spec.rb
 - spec/basehangul_spec.rb
 - spec/spec_helper.rb
 - spec/support/coverage.rb
+- spec/support/exit_code_matchers.rb
+- spec/support/file_helper.rb
+- spec/support/isolated_environment.rb
 - spec/support/shared_decode.rb