special_ratio 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5c09a10c6c2ca600f33ebaf977c701d82c9730c9
+  data.tar.gz: b17a9c0cf53919310d44c5894644539c6cc9876f
+SHA512:
+  metadata.gz: a3d97255229e170d9beca5137671a4ba9d16b4a7efd67fae52dd241505148a595c0f6c13bf5f849c351cb2370bc2d342bcdbe303f409dd6aa6ef7036734a4f3d
+  data.tar.gz: 2c32ae51160795f6654bed6e13bf8b331300da6fdf8a9bb90821eccb3492966833887a6ea39f0a36f3676025aeb0bbc8ec692b48ea32e83f3097593d47b51d03

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 kami30k
+
+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,55 @@
+# SpecialRatio
+
+[![Build Status](https://travis-ci.org/kami30k/special_ratio.svg?branch=master)](https://travis-ci.org/kami30k/special_ratio)
+[![Gem Version](https://badge.fury.io/rb/special_ratio.svg)](http://badge.fury.io/rb/special_ratio)
+
+SpecialRatio is a utility for designer.
+Calculate value for designing by using some classic methods.
+e.g. Golden Ratio, Silver Ratio.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'special_ratio'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install special_ratio
+
+## Usage
+
+![](.images/image.png)
+
+SpecialRatio has two class - GoldenRatio and SilverRatio.
+It expects for receive `:long` or `:short` or `:sum` parameter.
+
+Example of this gem is as follows:
+
+```ruby
+golden_ratio = SpecialRatio::GoldenRatio.new(long: 100)
+
+golden_ratio.long  #=> 100
+golden_ratio.short #=> 61.80469715698393
+golden_ratio.sum   #=> 161.80469715698393
+
+silver_ratio = SpecialRatio::SilverRatio.new(short: 100)
+
+silver_ratio.long  #=> 141.4
+silver_ratio.short #=> 100
+silver_ratio.sum   #=> 241.39999999999998
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/kami30k/special_ratio/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,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/special_ratio.rb

@@ -0,0 +1,4 @@
+require 'special_ratio/version'
+require 'special_ratio/ratio'
+require 'special_ratio/ratios/golden_ratio'
+require 'special_ratio/ratios/silver_ratio'

data/lib/special_ratio/ratio.rb

@@ -0,0 +1,48 @@
+module SpecialRatio
+  class Ratio
+    VALID_KEYS = [:long, :short, :sum]
+
+    def initialize(params)
+      params = params.select { |k, v| VALID_KEYS.include?(k) }
+
+      unless params.size == 1
+        raise ArgumentError, ':long or :short or :sum is required'
+      end
+
+      @key, @value = params.map { |k, v| [k, v] } .flatten
+    end
+
+    def long
+      case @key
+      when :long
+        @value
+      when :short
+        @value * @ratio
+      when :sum
+        @value * (@ratio / (@ratio + 1))
+      end
+    end
+
+    def short
+      case @key
+      when :long
+        @value / @ratio
+      when :short
+        @value
+      when :sum
+        @value / (@ratio + 1)
+      end
+    end
+
+    def sum
+      case @key
+      when :long
+        @value * ((@ratio + 1) / @ratio)
+      when :short
+        @value * (@ratio + 1)
+      when :sum
+        @value
+      end
+    end
+  end
+end

data/lib/special_ratio/ratios/golden_ratio.rb

@@ -0,0 +1,8 @@
+module SpecialRatio
+  class GoldenRatio < Ratio
+    def initialize(params)
+      @ratio = 1.618
+      super
+    end
+  end
+end

data/lib/special_ratio/ratios/silver_ratio.rb

@@ -0,0 +1,8 @@
+module SpecialRatio
+  class SilverRatio < Ratio
+    def initialize(params)
+      @ratio = 1.414
+      super
+    end
+  end
+end

data/lib/special_ratio/version.rb

@@ -0,0 +1,3 @@
+module SpecialRatio
+  VERSION = '0.2.0'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'special_ratio/ratio'
+require 'special_ratio/ratios/golden_ratio'
+require 'special_ratio/ratios/silver_ratio'

data/spec/special_ratio_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+describe SpecialRatio::Ratio do
+  describe 'GoldenRatio' do
+    context 'pass :long' do
+      let(:value) { SpecialRatio::GoldenRatio.new(long: 100) }
+
+      it 'should be calculated correctly' do
+        expect(value.long.round).to  eq(100)
+        expect(value.short.round).to eq(62)
+        expect(value.sum.round).to   eq(162)
+      end
+    end
+
+    context 'pass :short' do
+      let(:value) { SpecialRatio::GoldenRatio.new(short: 100) }
+
+      it 'should be calculated correctly' do
+        expect(value.long.round).to  eq(162)
+        expect(value.short.round).to eq(100)
+        expect(value.sum.round).to   eq(262)
+      end
+    end
+
+    context 'pass :sum' do
+      let(:value) { SpecialRatio::GoldenRatio.new(sum: 100) }
+
+      it 'should be calculated correctly' do
+        expect(value.long.round).to  eq(62)
+        expect(value.short.round).to eq(38)
+        expect(value.sum.round).to   eq(100)
+      end
+    end
+  end
+
+  describe 'SilverRatio' do
+    context 'pass :long' do
+      let(:value) { SpecialRatio::SilverRatio.new(long: 100) }
+
+      it 'should be calculated correctly' do
+        expect(value.long.round).to  eq(100)
+        expect(value.short.round).to eq(71)
+        expect(value.sum.round).to   eq(171)
+      end
+    end
+
+    context 'pass :short' do
+      let(:value) { SpecialRatio::SilverRatio.new(short: 100) }
+
+      it 'should be calculated correctly' do
+        expect(value.long.round).to  eq(141)
+        expect(value.short.round).to eq(100)
+        expect(value.sum.round).to   eq(241)
+      end
+    end
+
+    context 'pass :sum' do
+      let(:value) { SpecialRatio::SilverRatio.new(sum: 100) }
+
+      it 'should be calculated correctly' do
+        expect(value.long.round).to  eq(59)
+        expect(value.short.round).to eq(41)
+        expect(value.sum.round).to   eq(100)
+      end
+    end
+  end
+end

data/special_ratio.gemspec

@@ -0,0 +1,23 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'special_ratio/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'special_ratio'
+  spec.version       = SpecialRatio::VERSION
+  spec.authors       = ['kami30k']
+  spec.email         = ['kami30k@gmail.com']
+  spec.summary       = %q{Calculate value for designing by using some classic methods. e.g. Golden Ratio, Silver Ratio.}
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/kami30k/special_ratio'
+  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', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: special_ratio
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- kami30k
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-21 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: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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: Calculate value for designing by using some classic methods. e.g. Golden
+  Ratio, Silver Ratio.
+email:
+- kami30k@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".images/image.png"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/special_ratio.rb
+- lib/special_ratio/ratio.rb
+- lib/special_ratio/ratios/golden_ratio.rb
+- lib/special_ratio/ratios/silver_ratio.rb
+- lib/special_ratio/version.rb
+- spec/spec_helper.rb
+- spec/special_ratio_spec.rb
+- special_ratio.gemspec
+homepage: https://github.com/kami30k/special_ratio
+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: Calculate value for designing by using some classic methods. e.g. Golden
+  Ratio, Silver Ratio.
+test_files:
+- spec/spec_helper.rb
+- spec/special_ratio_spec.rb