anodator 0.0.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,28 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.9.2)
+    rcov (0.9.9)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  rcov
+  rspec (~> 2.3.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Tetsuhisa MAKINO
+
+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.ja.rdoc

@@ -0,0 +1,33 @@
+= anodator is Anonimous Data Validator
+
+anodator はテキストデータのチェックを支援するライブラリです。
+チェック対象となるテキストデータは配列形式で渡され、
+出力結果は二次元配列として出力されます。
+anodator はチェックに際し、受け取るデータの仕様、チェックするためのルールセット、
+および、出力時の仕様を受け取ることで、任意形式の入出力に対応します。
+通常は Ruby コード上で各種仕様の受け渡し等を実施しますが、簡易的な設定方法も
+提供されます。
+
+== インストール方法
+
+コマンドラインより下記のコマンドを実行してください。
+
+  $ gem install anodator
+
+== ライブラリとして使うには
+
+(後で書く)
+
+== コマンドとして使う
+
+(後で書く)
+
+== Author
+
+Tetsuhisa MAKINO <tim.makino at gmail.com>
+
+== Copyright
+
+Copyright (c) 2011 Tetsuhisa MAKINO. See LICENSE.txt for
+further details.
+

data/README.rdoc

@@ -0,0 +1,41 @@
+= anodator is Anonymous Data Validator
+
+anodator is a library to help you check the text data. Text data being checked
+is passed in an array, The output will be printed as two-dimensional array.
+anodator is checked upon the specifications of the received data, a set of rules
+for checking, And by receiving the output specification, corresponds to the
+input of any type. Although usually performed on the various specifications such
+as Ruby code and passing, how a simple set Will be provided.
+
+== How to install
+
+Please run the following command from the command line.
+
+  $ gem install anodator
+
+== To use a library
+
+(Written later)
+
+== To use a command
+
+(Written later)
+
+== Contributing to anodator
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Author
+
+Tetsuhisa MAKINO <tim.makino at gmail.com>
+
+== Copyright
+
+Copyright (c) 2011 Tetsuhisa MAKINO. See LICENSE.txt for
+further details.

data/Rakefile

@@ -0,0 +1,50 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "anodator"
+  gem.homepage = "https://github.com/maki-tetsu/anodator"
+  gem.license = "MIT"
+  gem.summary = %Q{anodator is Anonymous Data Validator.}
+  gem.description = %Q{anodator is Anonymous Data Validator.}
+  gem.email = "tim.makino at gmail.com"
+  gem.authors = ["Tetsuhisa MAKINO"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "anodator #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.options << "--charset=utf8"
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/example/example_01.rb

@@ -0,0 +1,129 @@
+# -*- coding: utf-8 -*-
+# Simple check example by anodator
+
+require File.join(File.dirname(__FILE__), "..", "lib", "anodator")
+include Anodator
+
+### target data columns
+# ID, Family name, First name, Sex, Phone number, Birthday, Blood type
+input_spec_array_definition =
+  [
+   { :number => "1", :name => "ID", },
+   { :number => "2", :name => "Family name", },
+   { :number => "3", :name => "First name", },
+   { :number => "4", :name => "Sex", },
+   { :number => "5", :name => "Phone number", },
+   { :number => "6", :name => "Birthday", },
+   { :number => "7", :name => "Blood type", },
+  ]
+input_spec = InputSpec.new(input_spec_array_definition)
+
+
+### check rules
+rule_set = RuleSet.new
+## ID
+# ID must be integer number
+validator = Validator::NumericValidator.new("1", :only_integer => true)
+rule_set << Rule.new("1", Message.new("[[1::name]] must be integer number.([[1::value]])"), validator)
+
+## Family name
+# Family name must not be blank
+# Family name length must be 2..20
+# Family name must be include a-z or A-Z and "'"
+validators = []
+validators << Validator::PresenceValidator.new("2")
+validators << Validator::LengthValidator.new("2", :in => 2..20)
+validators << Validator::FormatValidator.new("2", :format => /^[a-z']+$/i)
+validator = Validator::ComplexValidator.new(:validators => validators,
+                                            :logic => Validator::ComplexValidator::LOGIC_AND)
+rule_set << Rule.new("2",
+                     Message.new("[[2::name]] must be alphabets or \"'\", maximum length 20 and cannot be blank.([[2::value]])"),
+                     validator)
+
+## First name
+# Family name must not be blank
+# Family name length must be 2..20
+# Family name must be include a-z or A-Z and "'"
+validators = []
+validators << Validator::PresenceValidator.new("3")
+validators << Validator::LengthValidator.new("3", :in => 2..20)
+validators << Validator::FormatValidator.new("3", :format => /^[a-z']+$/i)
+validator = Validator::ComplexValidator.new(:validators => validators,
+                                            :logic => Validator::ComplexValidator::LOGIC_AND)
+rule_set << Rule.new("3",
+                     Message.new("[[3::name]] must be alphabets or \"'\", maximum length 20 and cannot be blank.([[3::value]])"),
+                     validator)
+
+## Sex
+# Sex is 'M' or 'F'
+validator = Validator::InclusionValidator.new("4", :in => %W(M F))
+rule_set << Rule.new("4",
+                     Message.new("[[4::name]] must be 'M' or 'F'.([[4::value]])"),
+                     validator)
+
+## Phone number
+# Phone number is only number
+# Phone number length must be maximum 12
+validators = []
+validators << Validator::LengthValidator.new("5", :maximum => 12, :allow_blank => true)
+validators << Validator::FormatValidator.new("5", :format => /^[0-9]+$/, :allow_blank => true)
+validator = Validator::ComplexValidator.new(:validators => validators,
+                                            :logic => Validator::ComplexValidator::LOGIC_AND)
+rule_set << Rule.new("5",
+                     Message.new("[[5::name]] must be include only integer number and mixumum length is 12.([[5::value]])"),
+                     validator)
+
+## Birthday
+# Birthday must be YYYY-MM-DD format
+validator = Validator::DateValidator.new("6")
+rule_set << Rule.new("6",
+                     Message.new("[[6::name]] must be date expression.([[6::value]])"),
+                     validator)
+
+## Blood type
+# Blood type must be include 'A', 'B', 'O' or 'AB'
+validator = Validator::InclusionValidator.new("7", :in => %W(A B O AB))
+rule_set << Rule.new("7",
+                     Message.new("[[7::name]] must be 'A', 'B', 'O' or 'AB'.(([[7::value]]))"),
+                     validator)
+
+### output spec
+## error list
+items =
+  [
+   "1",
+   :target_numbers,
+   :error_message,
+   :error_level
+  ]
+output_spec = OutputSpec.new(items,
+                             :target => OutputSpec::TARGET_ERROR,
+                             :include_no_error => false)
+
+### Checker
+checker = Checker.new(input_spec, rule_set, output_spec)
+
+### target datas
+datas =
+  [
+   ["1", "Murayama", "Honoka","F","08050967141","1971-10-01","B"],
+   ["2", "Izawa", "Kazuma", "M", "09070028635", "1968-03-24","O"],
+   ["3", "Hasebe", "Miyu", "F", "08087224562", "1991-01-21", "A"],
+   ["4", "Furusawa", "Eri", "F", "08017372898","1965-02-14", "O"],
+   ["5", "Hiramoto", "Yutaka", "M", "", "1986-09-14", "AB"],
+   ["6", "Matsuzaki", "Runa", "F", "", "1960-03-27", "O"],
+   ["7", "Inagaki", "Kouichi", "M", "", "1961-01-04", "B"],
+   ["8", "Kase", "Sueji", "", "", "1969-03-19", "B"],
+   ["9", "Kawanishi", "Hinako", "F", "08029628506", "1970-05-29", "B"],
+   ["10", "Sakurai", "Eijirou", "M", "", "1988-13-16", "A"],
+  ]
+
+### run check for all datas
+error_list = []
+datas.each do |data|
+  error_list += checker.run(data).first
+end
+
+error_list.each do |error|
+  puts "#{error[0]},#{error[3]},#{error[2]}"
+end

data/lib/anodator/anodator_error.rb

@@ -0,0 +1,5 @@
+module Anodator
+  # Basic error for anodator
+  class AnodatorError < StandardError; end
+  class InvalidConfiguration < AnodatorError ; end
+end

data/lib/anodator/check_result.rb

@@ -0,0 +1,41 @@
+require "anodator/rule"
+
+module Anodator
+  class CheckResult
+    attr_reader :target_numbers, :message, :level
+
+    def initialize(target_numbers, message, level)
+      @target_numbers = target_numbers.to_a
+      @message        = message.to_s
+      @level          = level
+
+      if @target_numbers.size.zero?
+        raise ArgumentError.new("target numbers cannot be blank")
+      end
+      if @message.split(//).size.zero?
+        raise ArgumentError.new("message cannot be blank")
+      end
+      unless [Rule::LEVEL_ERROR, Rule::LEVEL_WARNING].include?(level)
+        raise ArgumentError.new("level must be ERROR or WARNING")
+      end
+    end
+
+    def to_s
+      buf = "[      ]\t"
+      if @level == Rule::LEVEL_WARNING
+        buf = "[WARING]\t"
+      else
+        buf = "[ERROR ]\t"
+      end
+      buf += @message + " |#{@target_numbers.join(", ")}|"
+    end
+
+    def error?
+      return Rule::LEVEL_ERROR == @level
+    end
+
+    def warning?
+      return Rule::LEVEL_WARNING == @level
+    end
+  end
+end

data/lib/anodator/checker.rb

@@ -0,0 +1,58 @@
+require "anodator/input_spec"
+require "anodator/rule_set"
+require "anodator/output_spec"
+require "anodator/anodator_error"
+
+module Anodator
+  class Checker
+    def initialize(input_spec, rule_set, default_output_spec, configuration_check = false)
+      @input_spec   = input_spec
+      @rule_set     = rule_set
+      @output_specs = [default_output_spec]
+
+      unless @input_spec.is_a? InputSpec
+        raise ArgumentError.new("input_spec must be InputSpec object")
+      end
+      unless @rule_set.is_a? RuleSet
+        raise ArgumentError.new("rule_set must be RuleSet object")
+      end
+      unless @output_specs.first.is_a? OutputSpec
+        raise ArgumentError.new("default_output_spec must be OutputSpec object")
+      end
+
+      Validator::Base.values = @input_spec
+
+      validate_configuration if configuration_check
+    end
+
+    def validate_configuration
+      # RuleSet
+      @rule_set.validate_configuration
+      # OutputSpec
+      @output_specs.each do |spec|
+        spec.validate_configuration
+      end
+    end
+
+    def add_output_spec(output_spec, configuration_check = false)
+      unless output_spec.is_a? OutputSpec
+        raise ArgumentError.new("output_spec must be OutputSpec object")
+      end
+      @output_specs << output_spec
+
+      validate_configuration if configuration_check
+    end
+
+    def run(values)
+      @input_spec.source = values
+      @rule_set.check_all
+      @output_specs.map do |spec|
+        spec.generate(@input_spec, @rule_set.results)
+      end
+    end
+
+    def rule_info
+      @rule_set.to_s
+    end
+  end
+end

data/lib/anodator/input_spec.rb

@@ -0,0 +1,199 @@
+require "anodator/input_spec_item"
+require "anodator/anodator_error"
+
+module Anodator
+  class DuplicatedInputSpecItemError < AnodatorError; end
+  class UnknownTargetExpressionError < AnodatorError; end
+  class SourceDataNotProvidedError < AnodatorError; end
+
+  class InputSpec
+    CALCULATION_HOLDER_REGEXP = /\[\[([^\]]+)\]\]/
+
+    def initialize(spec_items = [])
+      @spec_items  = []
+      @source      = nil
+      @number_dict = { }
+      @name_dict   = { }
+
+      unless spec_items.is_a? Array
+        raise ArgumentError.new("initialized by Array by Hash(key is :name and :number")
+      end
+
+      spec_items.each do |spec_item_values|
+        if spec_item_values.keys.include?(:number) &&
+            spec_item_values.keys.include?(:name)
+          if spec_item_values.keys.include?(:type) &&
+              !spec_item_values[:type].nil?
+            push_spec_items(InputSpecItem.new(spec_item_values[:number],
+                                              spec_item_values[:name],
+                                              spec_item_values[:type]))
+          else
+            push_spec_items(InputSpecItem.new(spec_item_values[:number],
+                                              spec_item_values[:name]))
+          end
+        end
+      end
+    end
+
+    def push_spec_items(spec)
+      if @number_dict.keys.include?(spec.number)
+        raise DuplicatedInputSpecItemError.new("duplicated number spec item '#{spec.number}'")
+      end
+      if @name_dict.keys.include?(spec.name)
+        raise DuplicatedInputSpecItemError.new("duplicated name spec item '#{spec.name}'")
+      end
+      @spec_items << spec
+      index = @spec_items.size - 1
+      @number_dict[spec.number] = { :item => spec, :index => index }
+      @name_dict[spec.name]     = { :item => spec, :index => index }
+    end
+    private :push_spec_items
+
+    def source=(source)
+      if source.respond_to? :[]
+        @source = source
+      else
+        raise ArgumentError.new("source should respond to :[] method")
+      end
+    end
+
+    def clear_source
+      @source = nil
+    end
+
+    def value_at(index)
+      raise SourceDataNotProvidedError.new if @source.nil?
+
+      if @spec_items[index].nil?
+        raise UnknownTargetExpressionError.new("accessed by index '#{index}'")
+      else
+        return @source[index].to_s
+      end
+    end
+
+    def value_at_by_number(number)
+      raise SourceDataNotProvidedError.new if @source.nil?
+
+      if @number_dict.keys.include?(number)
+        return value_at(@number_dict[number][:index])
+      else
+        raise UnknownTargetExpressionError.new("accessed by number '#{number}'")
+      end
+    end
+
+    def value_at_by_name(name)
+      raise SourceDataNotProvidedError.new if @source.nil?
+
+      if @name_dict.keys.include?(name)
+        return value_at(@name_dict[name][:index])
+      else
+        raise UnknownTargetExpressionError.new("accessed by name '#{name}'")
+      end
+    end
+
+    def value_by_calculation(calculation)
+      holders = check_calculation_expression(calculation)
+
+      values = holders.inject({ }) do |hash, expression|
+        value = self[expression]
+        spec = spec_item_by_expression(expression)
+
+        case spec.type
+        when InputSpecItem::TYPE_NUMERIC
+          hash["[[#{expression}]]"] = %Q|BigDecimal("#{value}")|
+        else # String, other
+          hash["[[#{expression}]]"] = %Q|"#{value}"|
+        end
+        next hash
+      end
+
+      calculation.gsub!(CALCULATION_HOLDER_REGEXP) do |match|
+        values[match]
+      end
+
+      value = eval(calculation)
+      value = value.to_s("F") if value.is_a? BigDecimal
+
+      return value
+    rescue UnknownTargetExpressionError => ex
+      raise
+    rescue => ex
+      raise UnknownTargetExpressionError.new("accessed by calculation '#{calculation}'")
+    end
+    private :value_by_calculation
+
+    def [](target_expression)
+      raise SourceDataNotProvidedError.new if @source.nil?
+
+      if target_expression.is_a? Fixnum
+        return value_at(target_expression)
+      elsif /^CALC::(.+)$/.match target_expression
+        return value_by_calculation($1)
+      else
+        begin
+          return value_at_by_number(target_expression)
+        rescue UnknownTargetExpressionError
+          return value_at_by_name(target_expression)
+        end
+      end
+    end
+
+    def spec_item_at(index)
+      if @spec_items[index].nil?
+        raise UnknownTargetExpressionError.new("accessed by index '#{index}'")
+      else
+        @spec_items[index].dup
+      end
+    end
+
+    def spec_item_at_by_number(number)
+      if @number_dict.keys.include?(number)
+        return @number_dict[number][:item].dup
+      else
+        raise UnknownTargetExpressionError.new("accessed by number '#{number}'")
+      end
+    end
+
+    def spec_item_at_by_name(name)
+      if @name_dict.keys.include?(name)
+        return @name_dict[name][:item].dup
+      else
+        raise UnknownTargetExpressionError.new("accessed by name '#{name}'")
+      end
+    end
+
+    def spec_items_by_calculation(calculation)
+      holders = check_calculation_expression(calculation)
+      holders.map do |expression|
+        spec_item_by_expression(expression)
+      end
+    end
+    private :spec_items_by_calculation
+
+    def spec_item_by_expression(target_expression)
+      if target_expression.is_a? Fixnum
+        return spec_item_at(target_expression)
+      elsif /^CALC::(.+)$/.match target_expression
+        return spec_items_by_calculation($1)
+      else
+        begin
+          return spec_item_at_by_number(target_expression)
+        rescue UnknownTargetExpressionError
+          return spec_item_at_by_name(target_expression)
+        end
+      end
+    end
+
+    # return all holders specs
+    def check_calculation_expression(calculation)
+      if /(@|require|load|;)/.match calculation
+        return ArgumentError.new("Invalid calcuation expression '#{calcuation}'")
+      end
+
+      calculation.scan(CALCULATION_HOLDER_REGEXP).flatten.map do |target_expression|
+        spec_item_by_expression(target_expression)
+        next target_expression
+      end
+    end
+  end
+end

data/lib/anodator/input_spec_item.rb

@@ -0,0 +1,33 @@
+module Anodator
+  class InputSpecItem
+    TYPE_STRING  = "STRING"
+    TYPE_NUMERIC = "NUMERIC"
+    TYPE_DATE    = "DATE"
+
+    attr_reader :number, :name, :type
+
+    def initialize(number, name, type = TYPE_STRING)
+      if number.nil? || number.to_s.split(//).size.zero?
+        raise ArgumentError.new("number cannot be blank")
+      end
+      if name.nil? || name.to_s.split(//).size.zero?
+        raise ArgumentError.new("name cannot be blank")
+      end
+      unless [TYPE_STRING, TYPE_NUMERIC, TYPE_DATE].include?(type)
+        raise ArgumentError.new("unknown data type '#{type}'")
+      end
+
+      @number = number
+      @name = name
+      @type = type
+    end
+
+    def ==(other)
+      if other.is_a? InputSpecItem
+        self.number == other.number
+      else
+        return false
+      end
+    end
+  end
+end