shellfish 0.0.1

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+-fd -c --require=spec_helper

data/ChangeLog.md

@@ -0,0 +1,7 @@
+ChangeLog of Shellfish
+======================
+
+0.0.1 released 2012-07-28
+-------------------------
+
+- Initial release.

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Guardfile

@@ -0,0 +1,8 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Yuya Takeyama
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,37 @@
+# Shellfish
+
+Solve problem, learn shell commands.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'shellfish'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install shellfish
+
+## Usage
+
+    $ shellfish PROBLEM_DEFINITION_FILE [...]
+
+## Writing Problem Definition File
+
+It's can be written with DSL.
+
+   subject "Subject of the problem"
+   desc "Description of the problem"
+   expected "Expected output"
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/bin/shellfish

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'shellfish'
+require 'shellfish/application'
+
+app = Shellfish::Application.new(ARGV.dup)
+app.start

data/examples/fizzbuzz.rb

@@ -0,0 +1,18 @@
+subject "FizzBuzz (1 ~ 15)"
+
+__END__
+1
+2
+Fizz
+4
+Buzz
+Fizz
+7
+8
+Fizz
+Buzz
+11
+Fizz
+13
+14
+FizzBuzz

data/lib/shellfish.rb

@@ -0,0 +1,4 @@
+require "shellfish/version"
+
+module Shellfish
+end

data/lib/shellfish/application.rb

@@ -0,0 +1,128 @@
+require 'shellfish/problem_loader'
+require 'rspec/expectations/differ'
+require 'termcolor'
+require 'optparse'
+require 'readline'
+
+module Shellfish
+  class QuitException < ::Exception; end
+  class NextProblemException < ::Exception; end
+  class SkipEvaluationException < ::Exception; end
+
+  class Application
+    def initialize(argv)
+      @argv   = argv
+      if @argv.empty?
+        @argv = [File.expand_path('../../examples/fizzbuzz.rb', File.dirname(__FILE__))]
+      end
+      @loader = ProblemLoader.new
+      @differ = RSpec::Expectations::Differ.new
+    end
+
+    def start
+      opt = OptionParser.new
+      opt.version = VERSION
+
+      opt.parse!(@argv)
+      play
+    end
+
+    def play
+      @problem_count = @argv.size
+      @current_count = 1
+      @argv.each do |file|
+        try_problem @loader.load(file)
+        @current_count += 1
+      end
+    rescue QuitException
+      puts "Quitting shellfish..."
+    ensure
+      puts "Good bye."
+    end
+
+    def try_problem(problem)
+      show_problem(problem)
+      while input = ::Readline.readline('shellfish $ ', true)
+        begin
+        on_skip if input =~ /^\s*:(?:skip|next)\s*$/
+        on_quit if input =~ /^\s*(?::?exit|:quit)\s*$/
+        on_show_problem(problem) if input =~ /^\s*:show\s*$/
+
+        output = `#{input}`
+        if problem.expected_result != output
+          on_ng problem, input, output
+        else
+          on_ok problem, input, output
+        end
+        puts
+        rescue NextProblemException
+          break
+        rescue SkipEvaluationException
+        end
+      end
+    end
+
+    def on_ok(problem, input, output)
+      puts "<green>OK</green>".termcolor
+      puts
+      show_string output
+      puts "<green>Congratulations!</green>".termcolor
+      puts
+      raise NextProblemException
+    end
+
+    def on_ng(problem, input, output)
+      puts "<red>NG</red>".termcolor
+      puts
+      show_diff output, problem.expected_result
+    end
+
+    def on_skip
+      puts "<yellow>Skipped</yellow>".termcolor
+      raise NextProblemException
+    end
+
+    def on_quit
+      raise QuitException
+    end
+
+    def on_show_problem(problem)
+      show_problem problem
+      raise SkipEvaluationException
+    end
+
+    def show_diff(output, expected)
+      diff = @differ.diff_as_string(output, expected).gsub(/^\n+/, '')
+      colored_diff = ''
+      diff.each_line do |line|
+        if line[0] == '@'
+          colored_diff += "<green><bold>#{line}</bold></green>".termcolor
+        elsif line[0] == '+'
+          colored_diff += "<blue><bold>#{line}</bold></blue>".termcolor
+        elsif line[0] == '-'
+          colored_diff += "<red><bold>#{line}</bold></red>".termcolor
+        else
+          colored_diff += line
+        end
+      end
+      show_string colored_diff
+    end
+
+    def show_problem(problem)
+      puts ("<blue>Problem</blue> (#{@current_count}/#{@problem_count}): " +
+            "<bold>#{problem.subject}</bold>").termcolor
+      puts "Description: #{problem.description}" if problem.desc?
+      puts
+      puts "<bold>Expected Result:</bold>".termcolor
+      show_string "<cyan>#{problem.expected_result}</cyan>".termcolor
+      puts
+    end
+
+    def show_string(string)
+      puts "-" * 72
+      print string
+      puts
+      puts "-" * 72
+    end
+  end
+end

data/lib/shellfish/problem.rb

@@ -0,0 +1,16 @@
+module Shellfish
+  class Problem
+    attr_accessor :subject, :description, :expected_result
+    alias expected expected_result
+    alias expected= expected_result=
+
+    def subject?
+      !(@subject.nil?)
+    end
+
+    def description?
+      !(@description.nil?)
+    end
+    alias desc? description?
+  end
+end

data/lib/shellfish/problem_dsl.rb

@@ -0,0 +1,24 @@
+module Shellfish
+  class ProblemDsl
+    attr_reader :problem
+
+    def initialize(problem, &block)
+      @problem = problem
+      instance_eval(&block) if block_given?
+    end
+
+    def subject(text)
+      @problem.subject = text
+    end
+
+    def description(text)
+      @problem.description = text
+    end
+    alias desc description
+
+    def expected_result(text)
+      @problem.expected_result = text
+    end
+    alias expected expected_result
+  end
+end

data/lib/shellfish/problem_loader.rb

@@ -0,0 +1,25 @@
+require 'shellfish/problem'
+require 'shellfish/problem_dsl'
+
+module Shellfish
+  class ProblemLoader
+    def load(file)
+      f = open(file)
+      result = f.read
+      f.close
+      load_from_string(result)
+    end
+
+    def load_from_string(input)
+      dsl, data = input.split("__END__\n")
+      script = <<-EOS
+        Shellfish::ProblemDsl.new(Shellfish::Problem.new) {
+          #{dsl}
+        }.problem
+      EOS
+      problem = eval script, TOPLEVEL_BINDING
+      problem.expected_result = data if data
+      problem
+    end
+  end
+end

data/lib/shellfish/version.rb

@@ -0,0 +1,3 @@
+module Shellfish
+  VERSION = "0.0.1"
+end

data/shellfish.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/shellfish/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Yuya Takeyama"]
+  gem.email         = ["sign.of.the.wolf.pentagram@gmail.com"]
+  gem.description   = %q{Solve problems, learn shell commands}
+  gem.summary       = %q{Solve problems, learn shell commands}
+  gem.homepage      = "https://github.com/yuya-takeyama/shellfish"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "shellfish"
+  gem.require_paths = ["lib"]
+  gem.version       = Shellfish::VERSION
+
+  gem.add_dependency 'diff-lcs', '~> 1.1.3'
+  gem.add_dependency 'termcolor'
+  gem.add_dependency 'rspec-expectations'
+
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'guard-rspec'
+end

data/spec/shellfish/problem_loader_spec.rb

@@ -0,0 +1,40 @@
+require 'shellfish/problem_loader'
+
+module Shellfish
+  describe ProblemLoader do
+    let(:loader) { Shellfish::ProblemLoader.new }
+
+    describe '#load_from_string' do
+      subject { loader.load_from_string(input) }
+      let(:input) { '' }
+
+      it { should be_a(Problem) }
+
+      context 'has subject' do
+        let(:input) { 'subject "Subject of the problem"' }
+        its(:subject) { should == "Subject of the problem" }
+      end
+
+      context 'has description' do
+        let(:input) { 'desc "Description of the problem"' }
+        its(:description) { should == "Description of the problem" }
+      end
+
+      context 'has expected result' do
+        let(:input) { 'expected "Expected result of the problem"' }
+        its(:expected) { should == "Expected result of the problem" }
+      end
+
+      context 'has expected result as data field' do
+        let(:input) {
+          "__END__\n" +
+          "foo\n" +
+          "bar\n" +
+          "baz\n"
+        }
+
+        its(:expected) { should == "foo\nbar\nbaz\n" }
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: shellfish
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Yuya Takeyama
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: diff-lcs
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.3
+- !ruby/object:Gem::Dependency
+  name: termcolor
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Solve problems, learn shell commands
+email:
+- sign.of.the.wolf.pentagram@gmail.com
+executables:
+- shellfish
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- ChangeLog.md
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/shellfish
+- examples/fizzbuzz.rb
+- lib/shellfish.rb
+- lib/shellfish/application.rb
+- lib/shellfish/problem.rb
+- lib/shellfish/problem_dsl.rb
+- lib/shellfish/problem_loader.rb
+- lib/shellfish/version.rb
+- shellfish.gemspec
+- spec/shellfish/problem_loader_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/yuya-takeyama/shellfish
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1692564327382767151
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1692564327382767151
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Solve problems, learn shell commands
+test_files:
+- spec/shellfish/problem_loader_spec.rb
+- spec/spec_helper.rb