habakiri 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 56cc0c84f2e66aaa1180f159e5bcd52d7b24c13e7e3f077ad44ad0158fa0887f
+  data.tar.gz: f272408238825b7b44415de618e080b140abce02c044a26d16bf86319cb14b4f
+SHA512:
+  metadata.gz: 291d44495b80ffd282023aeff8102fbc5e1543978d78de94aaa715743ffa2db1aa0b5fe7e979504fb7a31c5ec143e78955931a3285349c998ae2e4f000ed9f19
+  data.tar.gz: 226b5d38f5ebbecddfedc8620e15e9c6ae6ec12bffb5f09b5361f3be9b75014c0c0a1a2aef525b4ee1f1c5bcea4a539feec0b1aa0b5aee182f0793d1aeb5037d

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in habakiri.gemspec
+gemspec
+
+group :development do
+  gem 'rake', '~> 12.0'
+  gem 'rubocop'
+  gem 'minitest'
+end
+
+gem 'diff-lcs'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 diaphragm
+
+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,68 @@
+# Habakiri
+
+Habariki is a template match engine for strings that can extract part of text by template keywords.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'habakiri'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install habakiri
+
+## Usage
+
+```ruby
+require 'habakiri'
+
+template = <<TEMPLATE
+YOUR NAME：{{name}}
+EMAIL:{{email}}
+TELEPHONE NUMBER：{{tel}}
+Website URL：{{url}}
+ZIP CODE：{{zipcode}}
+ADDRESS:{{address}}
+NOTE：{{note}}
+TEMPLATE
+
+text = <<TEXT
+YOUR NAME：John
+EMAIL:email@email.com
+TELEPHONE NUMBER：+199999999
+Website URL：https://example.com/website/url
+ZIP CODE：000-0000
+ADDRESS:San Francisco, CA 94107 United States
+NOTE：
+Hello, world!
+Hello, ruby!
+Hello, habakiri!
+TEXT
+
+result = Habakiri.exec(template, text)
+pp result
+# =>
+# {"name"=>"John",
+#  "email"=>"email@email.com",
+#  "tel"=>"+199999999",
+#  "url"=>"https://example.com/website/url",
+#  "zipcode"=>"000-0000",
+#  "address"=>"San Francisco, CA 94107 United States",
+#  "note"=>"Hello, world!\n" + "Hello, ruby!\n" + "Hello, habakiri!"}
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/diaphragm/habakiri.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+task default: :test
+
+Rake::TestTask.new do |test|
+  test.test_files = Dir['test/**/test_*.rb']
+  test.verbose = true
+end

data/habakiri.gemspec

@@ -0,0 +1,21 @@
+require_relative 'lib/habakiri/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'habakiri'
+  spec.version       = Habakiri::VERSION
+  spec.authors       = ['diaphragm']
+  spec.email         = ['7163746+diaphragm@users.noreply.github.com']
+
+  spec.summary       = 'Strings template match engine'
+  spec.description   = 'Habariki is a template match engine for strings that can extract part of text by template keywords.'
+  spec.homepage      = 'https://github.com/diaphragm/habakiri'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0") - Dir['.*']
+  end
+  spec.require_paths = ['lib']
+end

data/lib/habakiri.rb

@@ -0,0 +1,44 @@
+require 'habakiri/version'
+require 'diff/lcs'
+
+class Habakiri
+  def initialize(prefix = '{{', suffix = '}}')
+    @prefix = prefix
+    @suffix = suffix
+  end
+
+  def exec(template, text)
+    diffs = Diff::LCS.sdiff(template.to_s, text.to_s)
+    matches = template.to_enum(:scan, /#{@prefix}.+?#{@suffix}/).map{ Regexp.last_match }
+
+    matches.each.with_object({}){|match, object|
+      start = match.begin(0)
+      last = match.end(0)
+      range = start...last
+      list = diffs.select{|d| range.include?(d.old_position) }
+
+      # 改行後の追加要素も対応する文字列とみなす
+      i = diffs.index{|d| d.old_position == last }
+      if i
+        loop do
+          diff = diffs[i]
+          if diff && (diff.action == '+' || (diff.action == '=' && /\R/.match?(diff.old_element)))
+            list.push(diff)
+            i += 1
+          else
+            break
+          end
+        end
+      end
+
+      key = match[0].delete_prefix(@prefix).delete_suffix(@suffix).chomp
+      object[key] = list.map(&:new_element).join.strip
+    }
+  end
+
+  class << self
+    def exec(template, text)
+      new.exec(template, text)
+    end
+  end
+end

data/lib/habakiri/version.rb

@@ -0,0 +1,3 @@
+class Habakiri
+  VERSION = '0.1.0'.freeze
+end

data/test/test_data/template_1.txt

@@ -0,0 +1,10 @@
+名前：{{name}}
+メールアドレス：{{email}}
+電話番号：{{tel}}
+URL：{{url}}
+郵便番号：{{zipcode}}
+住所：{{address}}
+駅名：{{station}}
+メモ1：{{memo1}}
+メモ2：{{memo2}}
+備考：{{note}}

data/test/test_data/template_2.txt

@@ -0,0 +1,34 @@
+お客様より、下記内容のお問合せがありました。
+ご確認の上、ご連絡をお願いいたします。
+
+■ お問合せのあったデータの情報 ■
+　下記URLをクリックすると問合せデータの詳細をご確認いただけます。
+　http://example.com/detail/
+　　No　　：{{no}}
+　　データ名：{{data_name}}
+　　住所　：
+　　料金　：{{cost}}
+
+■ お問合せ内容 ■
+・最新の状況を知りたい
+
+○その他、ご要望・ご質問など
+{{question}}
+
+■ お客様情報 ■
+○お名前/ふりがな
+{{name}}/{{kana}}
+
+○メールアドレス
+{{email}}
+
+○電話番号
+{{tel}}　連絡希望時間：特に希望なし
+
+○性別
+{{gender}}
+
+
+※お問合せ情報には、ご本人の個人情報が含まれている場合がございます。
+お取り扱いには十分にご留意ください。
+なお本個人情報は、資料送付や問合せに対する連絡以外での使用はできません。

data/test/test_data/template_3.txt

@@ -0,0 +1,7 @@
+YOUR NAME：{{name}}
+EMAIL:{{email}}
+TELEPHONE NUMBER：{{tel}}
+Website URL：{{url}}
+ZIP CODE：{{zipcode}}
+ADDRESS:{{address}}
+NOTE：{{note}}

data/test/test_data/text_1.txt

@@ -0,0 +1,10 @@
+名前：テストテスト
+メールアドレス：test.test@example.com
+電話番号：01201234567
+URL：https://example.com/path/to/homepage/1232
+郵便番号：100-0001
+住所：東京都千代田区1-1-1
+駅名：東京駅
+メモ1：メモメモ
+メモ2：メモメモ2
+備考：備考備考

data/test/test_data/text_2.txt

@@ -0,0 +1,35 @@
+お客様より、下記内容のお問合せがありました。
+ご確認の上、ご連絡をお願いいたします。
+
+■ お問合せのあったデータの情報 ■
+　下記URLをクリックすると問合せデータの詳細をご確認いただけます。
+　http://example.com/detail/111/11111/111111/?&lang=ja
+　　No　　： 12345678
+　　データ名：テストデータ
+　　住所　：北海道札幌市中央区12丁目3456
+　　料金　：12万3456円
+
+■ お問合せ内容 ■
+・最新の状況を知りたい
+
+○その他、ご要望・ご質問など
+いろはにほへとちりぬるをわかよたれそつねならむ
+ういのおくやまけふこえてあさきゆめみしえひもせす
+
+■ お客様情報 ■
+○お名前/ふりがな
+テスト太郎 / てすとたろう
+
+○メールアドレス
+test.test@example.com
+
+○電話番号
+090-0900-0900　連絡希望時間：12時から18時
+
+○性別
+女性
+
+
+※お問合せ情報には、ご本人の個人情報が含まれている場合がございます。
+お取り扱いには十分にご留意ください。
+なお本個人情報は、資料送付や問合せに対する連絡以外での使用はできません。

data/test/test_data/text_3.txt

@@ -0,0 +1,10 @@
+YOUR NAME：John
+EMAIL:email@email.com
+TELEPHONE NUMBER：+199999999
+Website URL：https://example.com/website/url
+ZIP CODE：000-0000
+ADDRESS:San Francisco, CA 94107 United States
+NOTE：
+Hello, world!
+Hello, ruby!
+Hello, habakiri!

data/test/test_habakiri.rb

@@ -0,0 +1,53 @@
+require 'minitest/autorun'
+require 'habakiri'
+
+class HabakiriTest < Minitest::Unit::TestCase
+  def test_case_1
+    template = File.read('test/test_data/template_1.txt')
+    text = File.read('test/test_data/text_1.txt')
+    result = Habakiri.exec(template, text)
+
+    assert_instance_of(Hash, result)
+    assert_equal('テストテスト', result['name'])
+    assert_equal('test.test@example.com', result['email'])
+    assert_equal('01201234567', result['tel'])
+    assert_equal('100-0001', result['zipcode'])
+    assert_equal('東京都千代田区1-1-1', result['address'])
+    assert_equal('東京駅', result['station'])
+    assert_equal('メモメモ', result['memo1'])
+    assert_equal('メモメモ2', result['memo2'])
+    assert_equal('備考備考', result['note'])
+  end
+
+  def test_case_2
+    template = File.read('test/test_data/template_2.txt')
+    text = File.read('test/test_data/text_2.txt')
+    result = Habakiri.exec(template, text)
+
+    assert_instance_of(Hash, result)
+    assert_equal('12345678', result['no'])
+    assert_equal('テストデータ', result['data_name'])
+    assert_equal('12万3456円', result['cost'])
+    assert_equal("いろはにほへとちりぬるをわかよたれそつねならむ\nういのおくやまけふこえてあさきゆめみしえひもせす", result['question'])
+    assert_equal('テスト太郎', result['name'])
+    assert_equal('てすとたろう', result['kana'])
+    assert_equal('test.test@example.com', result['email'])
+    assert_equal('090-0900-0900', result['tel'])
+    assert_equal('女性', result['gender'])
+  end
+
+  def test_case_3
+    template = File.read('test/test_data/template_3.txt')
+    text = File.read('test/test_data/text_3.txt')
+    result = Habakiri.exec(template, text)
+
+    assert_instance_of(Hash, result)
+    assert_equal('John', result['name'])
+    assert_equal('email@email.com', result['email'])
+    assert_equal('+199999999', result['tel'])
+    assert_equal('https://example.com/website/url', result['url'])
+    assert_equal('000-0000', result['zipcode'])
+    assert_equal('San Francisco, CA 94107 United States', result['address'])
+    assert_equal("Hello, world!\nHello, ruby!\nHello, habakiri!", result['note'])
+  end
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: habakiri
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- diaphragm
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-07-22 00:00:00.000000000 Z
+dependencies: []
+description: Habariki is a template match engine for strings that can extract part
+  of text by template keywords.
+email:
+- 7163746+diaphragm@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- habakiri.gemspec
+- lib/habakiri.rb
+- lib/habakiri/version.rb
+- test/test_data/template_1.txt
+- test/test_data/template_2.txt
+- test/test_data/template_3.txt
+- test/test_data/text_1.txt
+- test/test_data/text_2.txt
+- test/test_data/text_3.txt
+- test/test_habakiri.rb
+homepage: https://github.com/diaphragm/habakiri
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Strings template match engine
+test_files: []