typographic-unit 0.1.1 → 0.2.0

data/.gitignore

@@ -0,0 +1,7 @@
+html
+*~
+Gemfile.lock
+gems
+.bundle
+.yardoc
+pkg

data/Gemfile

@@ -0,0 +1,4 @@
+# -*- ruby -*-
+
+source 'https://rubygems.org'
+gemspec

data/HISTORY.md

@@ -0,0 +1,12 @@
+## 0.2.0 2013-03-10
+
+* Changed to use bundler
+* Refactoring
+
+## 0.1.1 2007-12-30
+
+* add AmericanPoint and Gou
+
+## 0.1.0 2007-12-19
+
+* Initial release

data/{License.txt → LICENSE.txt}

@@ -1,4 +1,6 @@
-Copyright (c) 2007 Keita Yamaguchi
+Copyright (c) 2007-2013 Keita Yamaguchi
+
+MIT License
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -17,4 +19,4 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,87 @@
+# typographic-unit
+
+typographic-unit is a Ruby library for converting between typographic units
+according to TeX's way. This library can handle the following units:
+
+* TeX Scaled Point(sp)
+* TeX Point(pt)
+* Pica(pt)
+* Inch(in)
+* TeX Big Point(bp)
+* PostScript Point(ps_pt)
+* Meter(m)
+* Centimeter(cm)
+* Milimeter(mm)
+* Didot Point(dd)
+* Cicero(cc)
+* Japanese Q(q)
+* American Point(american_pt)
+* JIS Point(jis_pt)
+* Japanese Gou(gou)
+
+## Installing
+
+    gem install typographic-unit
+
+## How to use
+
+### Basics
+
+```ruby
+require "typographic-unit"
+1.cm          # => #<1cm>
+1.cm - 1.mm   # => #<0.9cm>
+1.cm == 10.mm # => true
+1.in >> :cm          # => #<2.54cm>
+2.54.cm >> :in       # => #<1.0in>
+1.in - 1.cm          # => #<0.606299212598425in>
+(1.in - 1.cm) >> :cm # => #<1.54cm>
+```
+
+### Convert
+
+```ruby
+1.pt >> :mm     # => #<0.351459803514598mm>
+7227.pt >> :cm  # => #<254.0cm>
+1.in >> :bp     # => #<72.0bp>
+1.pt >> :sp     # => #<65536.0sp>
+1157.pt >> :pt  # => #<1238.0pt>
+1.cc >> :dd     # => #<12.0dd>
+10.q >> :mm     # => #<2.5mm>
+1.jis_pt >> :mm # => #<0.3514mm>
+```
+
+### Calculate
+
+```ruby
+1.cm + 1.mm # => #<1.1cm>
+1.cm + 1.in # => #<3.54cm>
+1.pt - 1.bp # => #<-0.00131797426317971mm>
+100.ps_pt - 100.jis_pt >> :mm # => #<0.137777777777779mm>
+1.cm * 10   # => #<10cm>
+```
+
+### Step
+
+```ruby
+list = []
+1.cm.step(3.cm, 0.5.cm) do |i|
+  list << i
+end
+list # => [1.cm, 1.5.cm, 2.cm, 2.5.cm, 3.cm]
+```
+
+## License
+
+This code is free to use under the terms of the MIT license.
+
+## Reference
+
+* "Wikipedia:活字":http://ja.wikipedia.org/wiki/%E6%B4%BB%E5%AD%97
+* "歴史の文字 記載・活字・活版 第三部 活版の世界":http://www.um.u-tokyo.ac.jp/publish_db/1996Moji/05/5901.html
+* "CyberLibrarian:文字サイズ":http://www.asahi-net.or.jp/~ax2s-kmtn/ref/type_size.html
+
+## Links
+
+* [Project Home](http://typographic-unit.github.com/)
+* [Repository](http://rubyforge.org/projects/typographicunit/)

data/Rakefile

@@ -1,4 +1,16 @@
-require 'config/requirements'
-require 'config/hoe' # setup Hoe + all gem configuration
-
-Dir['tasks/**/*.rake'].each { |rake| load rake }
+require "bundler/gem_tasks"
+
+desc 'Test specs'
+task 'test' do
+  sh "bacon -a"
+end
+
+desc 'Generate API document'
+task 'html' do
+  sh "yard doc -o html --hide-void-return --no-api"
+end
+
+desc 'Show undocumented function list'
+task 'html:undoc' do
+  sh "yard stats --list-undoc --no-api"
+end

data/lib/typographic-unit.rb

@@ -1,10 +1,11 @@
-require "rational"
-
+# TypographicUnit is a namespece for unit classes.
 module TypographicUnit
-  Table = Hash.new
+  # @api private
+  TABLE = Hash.new
 
-  def self.open #:nodoc:
-    Table.values.each do |unit|
+  # Initialize typographic-unit. This makes unit methods for Numeric.
+  def self.init
+    TABLE.values.each do |unit|
       ::Numeric.instance_eval do
         define_method(unit.short) do
           unit.new(self)
@@ -12,285 +13,26 @@ module TypographicUnit
       end
     end
   end
-
-  class Unit < ::Numeric
-    def self.register(short, unit)
-      TypographicUnit::Table[short] = unit
-    end
-
-    def self.unit(short, base, size)
-      @short = short
-      @base = base
-      @size = size
-      register(short, self)
-    end
-
-    def self.short; @short; end
-    def self.base; @base; end
-    def self.size; @size; end
-
-    attr_reader :value
-
-    def initialize(value)
-      unless value.kind_of?(Numeric) and not(value.kind_of?(Unit))
-        raise ArgumentError.new, value
-      end
-      @value = value
-    end
-
-    # Convert the value into scaled point.
-    def scaled_point
-      val = self.class.base.new(@value * self.class.size)
-      val.kind_of?(ScaledPoint) ? val : val.scaled_point
-    end
-
-    def <=>(other)
-      raise ArgumentError, other unless other.kind_of?(Unit)
-      self.scaled_point.value.to_i <=> other.scaled_point.value.to_i
-    end
-
-    # Convert the length into other unit
-    # other:: unit
-    def >>(other)
-      oclass = other.kind_of?(Symbol) ? Table[other] : other
-      u = oclass.new(1)
-      oclass.new((self.scaled_point.value / u.scaled_point.value).to_f)
-    end
-
-    def %(other)
-      case other
-      when Unit
-        self.class.new(@value % (other >> self.class).value)
-      when Integer, Float
-        self.class.new(@value % other)
-      else
-        raise ArgumentError, other
-      end
-    end
-
-    def div(other)
-      case other
-      when Unit
-        @value.div((other >> self.class).value)
-      when Integer, Float
-        @value.div(other)
-      else
-        raise ArgumentError, other
-      end
-    end
-
-    def quo(other)
-      case other
-      when Unit
-        @value.quo((other >> self.class).value)
-      when Integer, Float
-        @value.quo(other)
-      else
-        raise ArgumentError, other
-      end
-    end
-
-    def +@
-      self.class.new(+@value)
-    end
-
-    def -@
-      self.class.new(-@value)
-    end
-
-    def abs
-      self.class.new(@value.abs)
-    end
-
-    def +(other)
-      raise ArgumentError, other unless other.kind_of?(Unit)
-      self.class.new((@value + (other >> self.class).value).to_f)
-    end
-
-    def -(other)
-      raise ArgumentError, other unless other.kind_of?(Unit)
-      self.class.new((@value - (other >> self.class).value).to_f)
-    end
-
-    def *(other)
-      raise ArgumentError, other unless other.kind_of?(Integer) or other.kind_of?(Float)
-      self.class.new(@value * other)
-    end
-
-    def ceil
-      self.class.new(@value.ceil)
-    end
-
-    def floor
-      self.class.new(@value.floor)
-    end
-
-    def round
-      self.class.new(@value.round)
-    end
-
-    def truncate
-      self.class.new(@value.truncate)
-    end
-
-    def integer?
-      @value.integer?
-    end
-
-    def nonzero?
-      @value.nonzero?
-    end
-
-    def to_i
-      self.class.new(@value.to_i)
-    end
-
-    def to_f
-      self.class.new(@value.to_f)
-    end
-
-    def to_int
-      @value.to_i
-    end
-
-    def to_float
-      @value.to_f
-    end
-
-    def zero?
-      @value.zero?
-    end
-
-    def step(limit, _step=1)
-      step = _step.kind_of?(Unit) ? _step : self.class.new(_step)
-      @value.step(limit.value, (step >> self.class).value) do |n|
-        yield(self.class.new(n)) if block_given?
-      end
-    end
-
-    def to_s
-      @value.to_s + self.class.short.to_s
-    end
-
-    def inspect
-      "#<#{@value.to_s}#{self.class.short.to_s}>"
-    end
-
-    alias :eql? :==
-    alias :convert :>>
-  end
-
-  class ScaledPoint < Unit
-    unit :sp, self, 1
-  end
-
-  # TeXPoint is a unit of TeX point. 1 TeX point equals 65536 scaled point.
-  class TeXPoint < Unit
-    unit :pt, ScaledPoint, 65536
-  end
-
-  class Pica < Unit
-    unit :pc, TeXPoint, 12
-  end
-
-  # Inch is a unit of inch. 7227 TeX point equals 100 inch.
-  class Inch < Unit
-    unit :in, TeXPoint, Rational(7227, 100)
-  end
-
-  class BigPoint < Unit
-    unit :bp, Inch, Rational(1, 72)
-  end
-
-  class PostScriptPoint < Unit
-    unit :ps_pt, BigPoint, 1
-  end
-
-  class Millimeter < Unit
-    unit :mm, Inch, Rational(10, 254)
-  end
-
-  class Centimeter < Unit
-    unit :cm, Millimeter, 10
-  end
-
-  class Meter < Unit
-    unit :m, Centimeter, 100
-  end
-
-  class DidotPoint < Unit
-    unit :dd, TeXPoint, Rational(1238, 1157)
-  end
-
-  class Cicero < Unit
-    unit :cc, DidotPoint, 12
-  end
-
-  # Q is a unit of Japanese Q(級).
-  class Q < Unit
-    unit :q, Millimeter, Rational(25, 100)
-  end
-
-  # AmericanPoint is a unit of American point.
-  # See http://www.ops.dti.ne.jp/~robundo/TMTaroY01.html for details.
-  class AmericanPoint < Unit
-    unit :american_pt, Millimeter, Rational(3514, 10000)
-  end
-
-  # JISPoint is a unit of JIS point. JIS point is just same as American point.
-  class JISPoint < AmericanPoint
-    unit :jis_pt, AmericanPoint, 1
-  end
-
-  # Gou is a unit of Japanese Gou(号).
-  # See http://www.um.u-tokyo.ac.jp/publish_db/1996Moji/05/5901.html and
-  # http://www.asahi-net.or.jp/~ax2s-kmtn/ref/type_size.html for details.
-  # In this library, "初号" is Gou.new(:first) or 0.gou.
-  class Gou < Unit
-    unit :gou, AmericanPoint, nil
-
-    def initialize(value)
-      if value.kind_of?(Unit)
-        raise ArgumentError.new, value
-      end
-      unless (0..8).include?(value) or value == :first
-        raise ArgumentError.new, value
-      end
-      @value = value
-    end
-
-    # Return a size according to "初号".
-    def self.first
-      0.gou
-    end
-
-    # Convert the value into american point.
-    def scaled_point
-      val = case @value
-            when :first, 0
-              42.american_pt
-            when 1
-              27.5.american_pt
-            when 2
-              21.american_pt
-            when 3
-              15.75.american_pt
-            when 4
-              13.75.american_pt
-            when 5
-              10.5.american_pt
-            when 6
-              7.875.american_pt
-            when 7
-              5.25.american_pt
-            when 8
-              3.9375.american_pt
-            end
-      val.kind_of?(ScaledPoint) ? val : val.scaled_point
-    end
-  end
 end
 
-require "typographic-unit/version"
+require "rational"
 
-TypographicUnit.open
+require 'typographic-unit/version'
+require 'typographic-unit/unit'
+require 'typographic-unit/scaled-point'
+require 'typographic-unit/tex-point'
+require 'typographic-unit/pica'
+require 'typographic-unit/inch'
+require 'typographic-unit/big-point'
+require 'typographic-unit/postscript-point'
+require 'typographic-unit/millimeter'
+require 'typographic-unit/centimeter'
+require 'typographic-unit/meter'
+require 'typographic-unit/didot-point'
+require 'typographic-unit/cicero'
+require 'typographic-unit/q'
+require 'typographic-unit/american-point'
+require 'typographic-unit/jis-point'
+require 'typographic-unit/gou'
+
+TypographicUnit.init