antetype 0.0.2 → 0.0.3

data/Gemfile.lock

@@ -0,0 +1,88 @@
+PATH
+  remote: .
+  specs:
+    antetype (0.0.3)
+      bundler (~> 1.1.3)
+      thor (~> 0.14.6)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    builder (3.0.0)
+    cane (1.3.0)
+    code_statistics (0.2.13)
+    columnize (0.3.6)
+    cucumber (1.1.9)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.2)
+      gherkin (~> 2.9.0)
+      json (>= 1.4.6)
+      term-ansicolor (>= 1.0.6)
+    debugger (1.0.1)
+      columnize (>= 0.3.1)
+      debugger-linecache
+      debugger-ruby_core_source
+    debugger-linecache (1.1.1)
+      debugger-ruby_core_source (>= 1.1.1)
+    debugger-ruby_core_source (1.1.2)
+    diff-lcs (1.1.3)
+    flay (1.4.3)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    flog (2.5.3)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    gherkin (2.9.3)
+      json (>= 1.4.6)
+    haml (3.0.25)
+    hanna_gudao (0.3.2)
+      haml (= 3.0.25)
+      rdoc (~> 3.12)
+    json (1.7.3)
+    multi_json (1.3.5)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    reek (1.2.8)
+      ruby2ruby (~> 1.2)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    ruby2ruby (1.3.0)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    ruby_parser (2.3.1)
+      sexp_processor (~> 3.0)
+    sexp_processor (3.2.0)
+    simplecov (0.6.4)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+    term-ansicolor (1.0.7)
+    thor (0.14.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  antetype!
+  cane (~> 1.3.0)
+  code_statistics (= 0.2.13)
+  cucumber (~> 1.1.0)
+  debugger (~> 1.0.0)
+  flay (= 1.4.3)
+  flog (= 2.5.3)
+  hanna_gudao (= 0.3.2)
+  rake (~> 0.9.2.2)
+  rdoc (~> 3.12)
+  reek (~> 1.2.8)
+  rspec (~> 2.6.0)
+  ruby2ruby (= 1.3.0)
+  simplecov (= 0.6.4)

data/Rakefile

@@ -1 +1,7 @@
 require 'bundler/gem_tasks'
+require 'code_statistics'
+require 'antetype'
+
+require './tasks/helper'
+Dir["tasks/**/*.rake"].each { |t| load t }
+

data/antetype.gemspec

@@ -1,15 +1,14 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
-require "antetype/version"
 
 Gem::Specification.new do |s|
   s.name        = "antetype"
-  s.version     = Antetype::VERSION
+  s.version     = "0.0.3"
   s.authors     = ["Gudao Luo"]
   s.email       = ["gudao.luo@gmail.com"]
   s.homepage    = "http://www.lycom.de"
-  s.summary     = %q{Write a gem summary}
-  s.description = %q{Write a gem description}
+  s.summary     = %q{Learn how to develop the Gem package}
+  s.description = %q{学习如何开发Gem软件包}
 
   s.rubyforge_project = "antetype"
 
@@ -18,7 +17,22 @@ Gem::Specification.new do |s|
   # s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.executables   = 'antetype'
   s.require_paths = ["lib"]
-  
-  s.add_development_dependency 'rspec', '~> 2.6.0'
+
+  s.add_dependency 'bundler', '~> 1.1.3'
   s.add_dependency 'thor', '~> 0.14.6'
+
+  s.add_development_dependency 'rspec', '~> 2.6.0'
+  s.add_development_dependency 'cucumber', '~> 1.1.0'
+  s.add_development_dependency 'debugger', '~> 1.0.0'  
+  s.add_development_dependency 'rake', '~> 0.9.2.2'
+
+  s.add_development_dependency 'code_statistics', '= 0.2.13'
+  s.add_development_dependency 'cane', '~> 1.3.0'
+  s.add_development_dependency 'rdoc', '~> 3.12'
+  s.add_development_dependency 'ruby2ruby', '= 1.3.0'
+  s.add_development_dependency 'reek', '~> 1.2.8'
+  s.add_development_dependency 'flog', '= 2.5.3'
+  s.add_development_dependency 'flay', '= 1.4.3'
+  s.add_development_dependency 'simplecov', '= 0.6.4'
+  s.add_development_dependency 'hanna_gudao', '= 0.3.2'
 end

data/bin/antetype

@@ -1,5 +1,4 @@
 #!/usr/bin/env ruby
 require 'antetype'
 
-Antetype::Base.start
-
+Antetype::Base.start

data/features/how_base_works_cn.feature

@@ -0,0 +1,21 @@
+# language: zh-CN, 简体中文版本
+功能: 检查功能函数执行情况
+为了验证功能函数
+作为功能函数的使用者
+我希望看到功能函数是否返回正确信息
+
+场景: 检验变量是否为常量
+当:我验证一个常量
+那么:我应该看到该常量类型是<constant>
+
+场景: 检验类是否存在
+当:我验证一个类Antetype::Base
+那么:我应该看到该类的类型是<Class>
+
+场景: 检验函数version是否返回正确信息
+当:我调用函数version
+那么:我应该看到函数version返回值是<0.0.3>
+
+场景: 检验函数show_antetype_dir是否返回正确信息
+当:我调用函数show_antetype_dir
+那么:我应该看到函数show_antetype_dir返回值是<~/.antetype>

data/features/step_definitions/how_base_works_cn.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+当 /^:我验证一个常量$/ do
+  @result = defined? Antetype::DEFAULT_CONFIG_PATH
+end
+那么 /^:我应该看到该常量类型是<(.*)>$/ do |result|
+  @result.should == result.downcase
+end
+
+当 /^:我验证一个类Antetype::Base$/ do
+  @result = Antetype::Base.class.to_s
+end
+那么 /^:我应该看到该类的类型是<(.*)>$/ do |result|
+  @result.should == result
+end
+
+当 /^:我调用函数version$/ do
+  #breakpoint
+  @result = Antetype::Base.new.version
+end
+那么 /^:我应该看到函数version返回值是<(.*)>$/ do |result|
+  @result.should == result
+end
+
+当 /^:我调用函数show_antetype_dir$/ do
+  @result = Antetype::Base.new.show_antetype_dir
+end
+那么 /^:我应该看到函数show_antetype_dir返回值是<(.*)>$/ do |result|
+  @result.should == result
+end

data/features/support/env.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+require 'antetype'
+require 'debugger'
+require 'simplecov'
+
+SimpleCov.start
+
+class SimpleCov::Formatter::QualityFormatter
+  def format(result)
+    SimpleCov::Formatter::HTMLFormatter.new.format(result)
+    File.open("coverage/covered_percent", "w") do |f|
+      f.puts result.source_files.covered_percent.to_f
+    end
+  end
+end
+
+SimpleCov.formatter = SimpleCov::Formatter::QualityFormatter

data/lib/antetype.rb

@@ -1,6 +1,9 @@
-require 'antetype/version'
 require 'antetype/base'
 
+# 模块Antetype定义两个方面内容：
+# - 软件包常量
+# - 继承Thor的对象，而对象Thor属于软件包Thor。
 module Antetype
+  # 定义软件包配置目录及其文件名称
   DEFAULT_CONFIG_PATH = '~/.antetype'
 end

data/lib/antetype/base.rb

@@ -1,10 +1,21 @@
 require 'thor'
 
 module Antetype
-  class Base  < Thor
-  	desc "show_antetype_dir", "show antetype dir"
-    def show_antetype_dir
-      say "#{Antetype::DEFAULT_CONFIG_PATH}", :green
+  # 对象Base完成一系列可执行如下功能:
+  # 　　实现所有软件包对外功能函数。
+  class Base < Thor
+    desc "version", "show antetype version"
+    # 返回软件包版本号
+    def version()
+      ver = Bundler.load.specs.
+              map{|gem| gem.version if 'antetype'==gem.name}.
+              find_all{|name| name!=nil}.
+              first.
+              to_s
+      say ver, :green
+      ver
     end
   end
 end
+
+require 'antetype/base/actions'

data/lib/antetype/base/actions.rb

@@ -0,0 +1,13 @@
+module Antetype
+  #
+  class Base
+    desc "show_antetype_dir", "show antetype dir"
+    # 返回软件包配置目录及其文件名称
+    def show_antetype_dir
+      dir = "#{Antetype::DEFAULT_CONFIG_PATH}"
+      say dir, :green
+      dir
+    end
+  end
+end
+

data/lib/antetype/version.rb

@@ -1,3 +0,0 @@
-module Antetype
-  VERSION = "0.0.2"
-end

data/tasks/cane.rake

@@ -0,0 +1,16 @@
+begin
+  require 'cane/rake_task'
+
+  namespace :cane do
+    desc "Run cane to check quality metrics"
+    Cane::RakeTask.new(:cane) do |cane|
+      cane.abc_max = 15
+      cane.add_threshold 'coverage/covered_percent', :>=, 99
+      cane.no_style = true
+    end
+
+    task :default => :cane
+  end
+rescue LoadError
+  abort "cane is unavailable. In order to run cane, you must: gem install cane"
+end

data/tasks/cucumber.rake

@@ -0,0 +1,10 @@
+begin
+  require 'cucumber/rake/task'
+  namespace :cucumber do
+    Cucumber::Rake::Task.new
+  end
+rescue LoadError
+  task :cucumber do
+    abort "Cucumber is not available. In order to run Cucumber, you must: sudo gem install cucumber"
+  end
+end

data/tasks/flay.rake

@@ -0,0 +1,17 @@
+begin
+  require "rake"
+  require "rake/tasklib"
+  require "flay"
+  namespace :flay do
+    require "flay_task"
+    FlayTask.new do |t|
+      t.verbose = true
+    end
+  end
+rescue LoadError
+  task :flay do
+    abort "Flay is not available. In order to run flay, you must: sudo gem install flay"
+  end
+end
+
+

data/tasks/flog.rake

@@ -0,0 +1,19 @@
+begin
+  require "rake"
+  require "rake/tasklib"
+  require "flog"
+  require "flog_task"
+  namespace :flog do
+    FlogTask.new do |t|
+      t.verbose = true
+      t.dirs = %w(app bin lib spec test)
+      # t.dirs = %w(app bin lib spec test features)
+      t.threshold = 200
+    end
+  end
+rescue LoadError
+  task :flog do
+    abort "Flog is not available. In order to run flog, you must: sudo gem install flog"
+  end
+end
+

data/tasks/hanna.rake

@@ -0,0 +1,15 @@
+begin
+  gem 'rdoc'
+  require 'rdoc/task'
+  namespace :hanna do
+    RDoc::Task.new do |rdoc|
+      rdoc.generator = 'hanna'
+      rdoc.rdoc_dir = 'hdoc'
+      rdoc.title = "Antetype #{Antetype::Base.new.version} Documentation"
+      rdoc.rdoc_files.include('lib/**/*.rb')
+      # rdoc.main = 'README.rdoc'
+      # rdoc.rdoc_files.include('README*')
+    end  end
+rescue LoadError
+  abort "hanna_gudao is unavailable. In order to run hanna_gudao, you must: gem install hanna_gudao"
+end

data/tasks/helper.rb

@@ -0,0 +1,22 @@
+# add rename_task method to Rake::Application
+# it has an internal hash with name -> Rake::Task mapping
+module Rake
+  class Application
+    def rename_task(task, old_name, new_name)
+      @tasks ||= {}
+      @tasks[new_name] = task
+      @tasks.delete old_name if @tasks.has_key? old_name
+    end
+  end
+end
+
+# add new rename method to Rake::Task class
+# to rename a task
+class Rake::Task
+  def rename(new_name)
+    return if new_name.nil? || @name == new_name
+    old_name = @name
+    @name = new_name.to_s
+    application.rename_task(self, old_name, @name)
+  end
+end

data/tasks/rake.rake

@@ -0,0 +1,9 @@
+# rename 'Rake' tasks
+Rake::Task[:build].rename(:"self:build")
+Rake::Task[:install].rename(:"self:install")
+Rake::Task[:release].rename(:"self:release")
+
+# desc "Runs all code quality metrics"
+# task :"antetype:quality" => [:"stats:stats", :"flog:flog", :"cane:cane", :"reek:reek"]#, :"flay:flay"]
+
+

data/tasks/rdoc.rake

@@ -0,0 +1,11 @@
+require 'rdoc/task'
+namespace :rdoc do
+  RDoc::Task.new do |t|
+    t.rdoc_dir = "rdoc"
+    t.title = "Antetype -- Software Development Method"
+    t.rdoc_files.include("lib/**/*.rb")
+    # t.rdoc_files.include('README.rdoc')
+    # t.rdoc_files.exclude 'lib/**/templates/**/*'
+    # t.main = "README.rdoc"
+  end
+end

data/tasks/reek.rake

@@ -0,0 +1,16 @@
+begin
+  require "reek"
+  require "reek/rake/task"
+  namespace :reek do
+    Reek::Rake::Task.new do |t|
+      t.source_files = 'lib/**/*.rb'
+      t.verbose = true
+      t.fail_on_error = true
+    end
+  end
+rescue LoadError
+  task :reek do
+    abort "Reek is unavailable. In order to run reek, you must: gem install reek"
+  end
+end
+

data/tasks/stats.rake

@@ -0,0 +1,4 @@
+# rename 'code_statistics' tasks
+Rake::Task[:stats].rename(:"stats:stats")
+Rake::Task[:code_stats].rename(:"stats:code_stats")
+

metadata

@@ -2,7 +2,7 @@
 name: antetype
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Gudao Luo
@@ -10,18 +10,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-04-14 00:00:00 Z
+date: 2012-05-26 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: bundler
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 2.6.0
-  type: :development
+        version: 1.1.3
+  type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: thor
@@ -34,7 +34,150 @@ dependencies:
         version: 0.14.6
   type: :runtime
   version_requirements: *id002
-description: Write a gem description
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.6.0
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.1.0
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: debugger
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.9.2.2
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: code_statistics
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.2.13
+  type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: cane
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.3.0
+  type: :development
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: rdoc
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "3.12"
+  type: :development
+  version_requirements: *id009
+- !ruby/object:Gem::Dependency 
+  name: ruby2ruby
+  prerelease: false
+  requirement: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 1.3.0
+  type: :development
+  version_requirements: *id010
+- !ruby/object:Gem::Dependency 
+  name: reek
+  prerelease: false
+  requirement: &id011 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.2.8
+  type: :development
+  version_requirements: *id011
+- !ruby/object:Gem::Dependency 
+  name: flog
+  prerelease: false
+  requirement: &id012 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 2.5.3
+  type: :development
+  version_requirements: *id012
+- !ruby/object:Gem::Dependency 
+  name: flay
+  prerelease: false
+  requirement: &id013 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 1.4.3
+  type: :development
+  version_requirements: *id013
+- !ruby/object:Gem::Dependency 
+  name: simplecov
+  prerelease: false
+  requirement: &id014 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.6.4
+  type: :development
+  version_requirements: *id014
+- !ruby/object:Gem::Dependency 
+  name: hanna_gudao
+  prerelease: false
+  requirement: &id015 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.3.2
+  type: :development
+  version_requirements: *id015
+description: "\xE5\xAD\xA6\xE4\xB9\xA0\xE5\xA6\x82\xE4\xBD\x95\xE5\xBC\x80\xE5\x8F\x91Gem\xE8\xBD\xAF\xE4\xBB\xB6\xE5\x8C\x85"
 email: 
 - gudao.luo@gmail.com
 executables: 
@@ -44,13 +187,31 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- .DS_Store
 - Gemfile
+- Gemfile.lock
 - Rakefile
 - antetype.gemspec
 - bin/antetype
+- features/how_base_works_cn.feature
+- features/step_definitions/.DS_Store
+- features/step_definitions/how_base_works_cn.rb
+- features/support/env.rb
 - lib/antetype.rb
 - lib/antetype/base.rb
+- lib/antetype/base/actions.rb
 - lib/antetype/version.rb
+- pkg/antetype-0.0.3.gem
+- tasks/cane.rake
+- tasks/cucumber.rake
+- tasks/flay.rake
+- tasks/flog.rake
+- tasks/hanna.rake
+- tasks/helper.rb
+- tasks/rake.rake
+- tasks/rdoc.rake
+- tasks/reek.rake
+- tasks/stats.rake
 homepage: http://www.lycom.de
 licenses: []
 
@@ -77,6 +238,10 @@ rubyforge_project: antetype
 rubygems_version: 1.8.22
 signing_key: 
 specification_version: 3
-summary: Write a gem summary
-test_files: []
-
+summary: Learn how to develop the Gem package
+test_files: 
+- features/how_base_works_cn.feature
+- features/step_definitions/.DS_Store
+- features/step_definitions/how_base_works_cn.rb
+- features/support/env.rb
+has_rdoc: