shioconv 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f61eb16a780a38b34e99d8b26090c0925f161ffd
+  data.tar.gz: b7aa1e9ec47530035666203b279062239744fd0d
+SHA512:
+  metadata.gz: 98a0d12b6d9e3e458d9ef9ebbc5d92309a97523fdd2518c89ed16ef5a03add5db4b2bb559f47b810ef7882fd364b2fbde3bdb229108706a628ce3b92444eabdd
+  data.tar.gz: 2346c916108d4e4a12c3926e0c4950d12719f698f25ef4f9a061172511aa03ba007d70de4aa4d6f6d46740d25cf2298b75fa8453d4f1c440d6a3834fe5fd82f6

data/.gitignore

@@ -0,0 +1,24 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+config/condiments.tsv
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in shioconv.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 SHIOYA, Hiromu
+
+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,43 @@
+# Shioconv
+
+convert between cubic contents and weight for typcal seasonings.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'shioconv'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install shioconv
+
+## Usage
+
+* convert amount of condiments between units
+
+```
+salt = Shioconv.measure(:salt, 1, :tbsp)
+
+salt.to_cc # => 15.0
+salt.to_g  # => 18.0
+```
+
+* show all condiments and units
+
+```
+Shioconv::Condiment.list # => returns array of string
+Shioconv::Unit.list      # => returns array of string
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/kwappa/shioconv/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+Bundler.setup
+require 'rspec/core/rake_task'
+
+desc "run spec"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = ["-c", "-fs"]
+end

data/config/condiments.rb

@@ -0,0 +1,25 @@
+require 'yaml'
+require 'csv'
+
+csv = CSV.read('./condiments.tsv', col_sep: "\t")
+csv.shift                       # drop title row
+
+result = csv.each_with_object([]) do |cols, r|
+  (key, japanese_name, english_name, specific_gravity, *synonyms) = cols.map(&:to_s)
+  next if key.empty?
+  synonyms = synonyms.find_all { |al| !al.empty? }.map(&:downcase)
+
+  r << {
+    key: key.to_sym,
+    japanese_name: japanese_name,
+    english_name: english_name,
+    specific_gravity: specific_gravity.to_f,
+    synonyms: synonyms
+  }
+end
+
+File.open('./condiments.yaml', 'w') { |yaml|
+  yaml.write YAML.dump(result)
+}
+
+p result

data/config/condiments.yaml

@@ -0,0 +1,171 @@
+---
+- :key: :water
+  :japanese_name: "水"
+  :english_name: water
+  :specific_gravity: 1.0
+  :synonyms: []
+- :key: :sake
+  :japanese_name: "酒"
+  :english_name: sake
+  :specific_gravity: 1.0
+  :synonyms:
+  - "日本酒"
+- :key: :wine
+  :japanese_name: "ワイン"
+  :english_name: wine
+  :specific_gravity: 1.0
+  :synonyms: []
+- :key: :vinegar
+  :japanese_name: "酢"
+  :english_name: vinegar
+  :specific_gravity: 1.0
+  :synonyms: []
+- :key: :soy_source
+  :japanese_name: "しょうゆ"
+  :english_name: soy source
+  :specific_gravity: 1.15
+  :synonyms:
+  - "醤油"
+- :key: :sweet_sake
+  :japanese_name: "本みりん"
+  :english_name: sweet dake
+  :specific_gravity: 1.15
+  :synonyms:
+  - "味醂"
+- :key: :fake_sweet_sake
+  :japanese_name: "みりん風調味料"
+  :english_name: fake sweet sake
+  :specific_gravity: 1.25
+  :synonyms: []
+- :key: :soybean_paste
+  :japanese_name: "みそ"
+  :english_name: soybean paste
+  :specific_gravity: 1.15
+  :synonyms:
+  - "味噌"
+- :key: :sea_salt
+  :japanese_name: "粗塩"
+  :english_name: sea salt
+  :specific_gravity: 0.9
+  :synonyms:
+  - "あら塩"
+- :key: :salt
+  :japanese_name: "食塩"
+  :english_name: salt
+  :specific_gravity: 1.2
+  :synonyms:
+  - "塩"
+- :key: :refined_salt
+  :japanese_name: "精製塩"
+  :english_name: refined salt
+  :specific_gravity: 1.2
+  :synonyms:
+  - "焼き塩"
+- :key: :castor_sugar
+  :japanese_name: "上白糖"
+  :english_name: castor sugar
+  :specific_gravity: 0.65
+  :synonyms:
+  - "砂糖"
+- :key: :granulated_sugar
+  :japanese_name: "グラニュー糖"
+  :english_name: granulated sugar
+  :specific_gravity: 0.9
+  :synonyms: []
+- :key: :brown_sugar
+  :japanese_name: "ざらめ"
+  :english_name: brown sugar
+  :specific_gravity: 1.0
+  :synonyms:
+  - "粗目"
+- :key: :starch_syrup
+  :japanese_name: "水あめ"
+  :english_name: starch syrup
+  :specific_gravity: 1.4
+  :synonyms:
+  - "水飴"
+- :key: :honey
+  :japanese_name: "はちみつ"
+  :english_name: honey
+  :specific_gravity: 1.4
+  :synonyms:
+  - "蜂蜜"
+- :key: :jam
+  :japanese_name: "ジャム"
+  :english_name: jam
+  :specific_gravity: 1.25
+  :synonyms:
+  - "ママレード"
+- :key: :marmalade
+  :japanese_name: "マーマレード"
+  :english_name: marmalade
+  :specific_gravity: 1.35
+  :synonyms: []
+- :key: :oil
+  :japanese_name: "油"
+  :english_name: oil
+  :specific_gravity: 0.9
+  :synonyms:
+  - "サラダ油"
+  - "サラダオイル"
+  - "オイル"
+- :key: :butter
+  :japanese_name: "バター"
+  :english_name: butter
+  :specific_gravity: 0.9
+  :synonyms: []
+- :key: :margarine
+  :japanese_name: "マーガリン"
+  :english_name: margarine
+  :specific_gravity: 0.9
+  :synonyms: []
+- :key: :lard
+  :japanese_name: "ラード"
+  :english_name: lard
+  :specific_gravity: 0.85
+  :synonyms: []
+- :key: :shortening
+  :japanese_name: "ショートニング"
+  :english_name: shortening
+  :specific_gravity: 0.8
+  :synonyms: []
+- :key: :cornstarch
+  :japanese_name: "コーンスターチ"
+  :english_name: cornstarch
+  :specific_gravity: 0.5
+  :synonyms: []
+- :key: :flour
+  :japanese_name: "小麦粉"
+  :english_name: flour
+  :specific_gravity: 0.55
+  :synonyms:
+  - strong_flour
+  - medium_flour
+  - weak_flour
+- :key: :starch
+  :japanese_name: "片栗粉"
+  :english_name: starch
+  :specific_gravity: 0.65
+  :synonyms: []
+- :key: :milk
+  :japanese_name: "牛乳"
+  :english_name: milk
+  :specific_gravity: 1.05
+  :synonyms: []
+- :key: :cream
+  :japanese_name: "生クリーム"
+  :english_name: cream
+  :specific_gravity: 1.0
+  :synonyms: []
+- :key: :ketchup
+  :japanese_name: "ケチャップ"
+  :english_name: ketchup
+  :specific_gravity: 1.15
+  :synonyms:
+  - "トマトケチャップ"
+- :key: :worcestershire_sauce
+  :japanese_name: "ウスターソース"
+  :english_name: worcestershire sauce
+  :specific_gravity: 1.2
+  :synonyms:
+  - "ソース"

data/lib/shioconv/condiment.rb

@@ -0,0 +1,36 @@
+class Shioconv::Condiment < OpenStruct
+  def self.find_by(condiment)
+    # find by key
+    if condiment.is_a?(Symbol)
+      result = raw_data.find { |data| data[:key] == condiment }
+      return self.new(result) if result
+    end
+
+    # find by name
+    condiment = condiment.to_s.downcase
+    [:japanese_name, :english_name].each do |key|
+      result = raw_data.find { |data| data[key] == condiment }
+      return self.new(result) if result
+    end
+
+    # find by synonyms
+    result = raw_data.find { |data| data[:synonyms].include?(condiment) }
+    return self.new(result) if result
+
+    raise ArgumentError.new("condiment '#{condiment}' does not found.")
+  end
+
+  def self.data_file
+    File.join(File.dirname(File.expand_path(__FILE__)), %w(.. .. config condiments.yaml))
+  end
+
+  def self.raw_data
+    @@raw_data ||= YAML.parse(File.read(data_file)).to_ruby
+  end
+
+  def self.list
+    raw_data.map do |datum|
+      "#{sprintf('%-16s', datum[:key])} : 「#{datum[:japanese_name]}(#{datum[:english_name]})」"
+    end
+  end
+end

data/lib/shioconv/unit.rb

@@ -0,0 +1,64 @@
+class Shioconv::Unit
+  attr_reader :type, :name, :value
+
+  UNIT_TYPES = {
+    volume: {
+      cc:        1.0,
+      ml:        1.0,
+      tbsp:     15.0,
+      tsp:       5.0,
+      cup:     200.0,
+      us_cup:  236.56,
+      jp_cup:  200.0,
+    },
+    weight: {
+      g:         1.0,
+      kg:     1000.0,
+      oz:       28.349,
+      lb:      453.592,
+    },
+  }.freeze
+
+  CONVERTABLE_UNITS = UNIT_TYPES.map { |_, units| units.keys }.flatten.freeze
+
+  def self.find_by(unit_name)
+    UNIT_TYPES.each do |unit_type, units|
+      if units.has_key?(unit_name)
+        return self.new(type: unit_type, name: unit_name, value: units[unit_name])
+      end
+    end
+
+    raise ArgumentError.new("unit [#{unit_name}] does not found.") unless @name
+  end
+
+  def self.convertable?(unit)
+    CONVERTABLE_UNITS.include?(unit)
+  end
+
+  def self.list
+    UNIT_TYPES.map do |type, units|
+      (base_unit, _) = units.shift
+      "#{type}: #{base_unit}, " << units.map { |unit, value| "#{unit}(#{value}#{base_unit})" }.join(', ')
+    end
+  end
+
+  def initialize(type: type, name: name, value: value)
+    @type  = type
+    @name  = name
+    @value = value
+  end
+
+  def convert(condiment, quantity, dst_unit)
+    return quantity if name == dst_unit
+    dst_unit = self.class.find_by(dst_unit)
+
+    current_vavlue = quantity * value / dst_unit.value
+    if type == :weight && dst_unit.type == :volume
+      current_vavlue /= condiment.specific_gravity
+    elsif type == :volume && dst_unit.type == :weight
+      current_vavlue *= condiment.specific_gravity
+    end
+
+    current_vavlue
+  end
+end

data/lib/shioconv/version.rb

@@ -0,0 +1,3 @@
+class Shioconv
+  VERSION = "0.1.1"
+end

data/lib/shioconv.rb

@@ -0,0 +1,31 @@
+require 'yaml'
+require 'ostruct'
+
+require_relative "shioconv/version"
+require_relative "shioconv/unit"
+require_relative "shioconv/condiment"
+
+class Shioconv
+  attr_reader :condiment, :quantity, :unit
+
+  def self.measure(condiment_name, quantity, unit_name)
+    condiment = Condiment.find_by(condiment_name)
+    unit      = Unit.find_by(unit_name)
+
+    self.new(condiment: condiment, quantity: quantity, unit: unit)
+  end
+
+  def initialize(condiment: condiment, quantity: quantity, unit: unit)
+    @condiment = condiment
+    @quantity  = quantity
+    @unit      = unit
+  end
+
+  def method_missing(name, *args)
+    return super unless m = /\Ato_(?<dst_unit>\w+)\Z/.match(name)
+    dst_unit = m[:dst_unit].to_sym
+    return super unless Unit.convertable?(dst_unit)
+
+    @unit.convert(@condiment, @quantity, dst_unit)
+  end
+end

data/shioconv.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'shioconv/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "shioconv"
+  spec.version       = Shioconv::VERSION
+  spec.authors       = ["SHIOYA, Hiromu"]
+  spec.email         = ["kwappa.856@gmail.com"]
+  spec.summary       = %q{Shioconv converts between weight and volume of typical condiments.}
+  spec.description   = %q{Shioconv converts between weight and volume of typical condiments.}
+  spec.homepage      = "http://github.com/kwappa/shioconv"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/shioconv/unit_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe Shioconv::Unit do
+  let(:convertable_unit) { :g }
+  let(:not_convertable_unit) { :not_convertable_unit }
+
+  describe '.convertable?' do
+    context 'when convertable unit given' do
+      specify { expect(described_class.convertable?(convertable_unit)).to be_true }
+    end
+
+    context 'when not convertable unit given' do
+      specify { expect(described_class.convertable?(not_convertable_unit)).to be_false }
+    end
+  end
+end

data/spec/shioconv_spec.rb

@@ -0,0 +1,100 @@
+require 'spec_helper'
+
+describe Shioconv do
+  let(:invalid_condiment_name) { :invalid_condiment }
+  let(:invalid_unit_name) { :invalid_unit }
+
+  describe '.measure' do
+    context 'if invalid condiment_name given' do
+      specify { expect { Shioconv.measure(invalid_condiment_name, 1, :tbsp) }.to raise_error ArgumentError }
+    end
+
+    context 'if invalid unit name given' do
+      specify { expect { Shioconv.measure(:salt, 1, invalid_unit_name) }.to raise_error ArgumentError }
+    end
+  end
+
+  describe '#method_missing' do
+    subject(:salt) { Shioconv.measure(:salt, 1, :tbsp) }
+
+    shared_examples 'does not define instance method' do
+      it 'does not define instance method' do
+      expect(described_class.instance_methods(false)).to_not be_include(superclass_method)
+      end
+    end
+
+    context 'when called method that does not start with "to_"' do
+      let(:superclass_method) { :frozen? }
+      include_examples 'does not define instance method'
+      it 'delegates to superclass' do
+        expect(salt.send(superclass_method)).to be_false
+      end
+    end
+
+    context 'when called metod that starts with "to_" but not defined at self' do
+      let(:superclass_method) { :to_s }
+      include_examples 'does not define instance method'
+      it 'delegates to superclass' do
+        expect(salt.send(superclass_method)).to be_a(String)
+      end
+    end
+
+    context 'when called method that does not start with "to_" and not defined at all' do
+      let(:superclass_method) { :invalid_method_name }
+      include_examples 'does not define instance method'
+      it 'raises NoMethodError' do
+        expect { salt.send(superclass_method) }.to raise_error NoMethodError
+      end
+    end
+
+    context 'when called method that starts with "to_" and not defined at all' do
+      let(:superclass_method) { :to_invalid_method_name }
+      include_examples 'does not define instance method'
+      it 'raises NoMethodError' do
+        expect { salt.send(superclass_method) }.to raise_error NoMethodError
+      end
+    end
+
+    context 'when called convertable method' do
+      context 'from weight' do
+        subject(:soy_source) { Shioconv.measure(:soy_source, 10, :g) }
+
+        context 'to weight' do
+          it 'converts correctly from g to kg' do
+            expect(soy_source.to_kg).to be_within(0.01).of(0.01)
+          end
+
+          it 'converts correctly from g to oz' do
+            expect(soy_source.to_oz).to be_within(0.01).of(0.3527)
+          end
+        end
+
+        context 'to volume' do
+          it 'converts correctly from g to tbsp' do
+            expect(soy_source.to_tbsp).to be_within(0.01).of(0.5797)
+          end
+        end
+      end
+
+      context 'from value' do
+        subject(:soy_source) { Shioconv.measure(:soy_source, 15, :cc) }
+
+        context 'to volume' do
+          it 'converts correctly from cc to tbsp' do
+            expect(soy_source.to_tbsp).to be_within(0.01).of(1)
+          end
+
+          it 'converts correctly from cc to us_cpu' do
+            expect(soy_source.to_us_cup).to be_within(0.01).of(0.0634)
+          end
+        end
+
+        context 'to weight' do
+          it 'converts correctly from cc to g' do
+            expect(soy_source.to_g).to be_within(0.01).of(17.25)
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'bundler'
+Bundler.setup(:default, :test)
+$: << File.join(File.dirname(File.expand_path(__FILE__)), %w[.. lib])
+require 'shioconv'

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: shioconv
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- SHIOYA, Hiromu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Shioconv converts between weight and volume of typical condiments.
+email:
+- kwappa.856@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- config/condiments.rb
+- config/condiments.yaml
+- lib/shioconv.rb
+- lib/shioconv/condiment.rb
+- lib/shioconv/unit.rb
+- lib/shioconv/version.rb
+- shioconv.gemspec
+- spec/shioconv/unit_spec.rb
+- spec/shioconv_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/kwappa/shioconv
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Shioconv converts between weight and volume of typical condiments.
+test_files:
+- spec/shioconv/unit_spec.rb
+- spec/shioconv_spec.rb
+- spec/spec_helper.rb