typographic-unit 0.1.1 → 0.2.0

data/lib/typographic-unit/american-point.rb

@@ -0,0 +1,7 @@
+module TypographicUnit
+  # 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
+end

data/lib/typographic-unit/big-point.rb

@@ -0,0 +1,7 @@
+module TypographicUnit
+  # This is a class for big point(bp). Big point is defined as 1/72 inch in this
+  # library.
+  class BigPoint < Unit
+    unit :bp, Inch, Rational(1, 72)
+  end
+end

data/lib/typographic-unit/centimeter.rb

@@ -0,0 +1,7 @@
+module TypographicUnit
+  # This is a class for representing centimeter(cm). Centimeter is defined as 10
+  # millimeter in this library.
+  class Centimeter < Unit
+    unit :cm, Millimeter, 10
+  end
+end

data/lib/typographic-unit/cicero.rb

@@ -0,0 +1,7 @@
+module TypographicUnit
+  # This is a class for representing cicero(cc). Cicero is defined as 12 didot
+  # point in this library.
+  class Cicero < Unit
+    unit :cc, DidotPoint, 12
+  end
+end

data/lib/typographic-unit/didot-point.rb

@@ -0,0 +1,7 @@
+module TypographicUnit
+  # This is a class for representing didot point(dd). Didot point is defined as
+  # 1238/1157 tex point in this library.
+  class DidotPoint < Unit
+    unit :dd, TeXPoint, Rational(1238, 1157)
+  end
+end

data/lib/typographic-unit/gou.rb

@@ -0,0 +1,50 @@
+# -*- coding: utf-8 -*-
+module TypographicUnit
+  # 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

data/lib/typographic-unit/inch.rb

@@ -0,0 +1,6 @@
+module TypographicUnit
+  # Inch is a unit of inch. 7227 TeX point equals 100 inch.
+  class Inch < Unit
+    unit :in, TeXPoint, Rational(7227, 100)
+  end
+end

data/lib/typographic-unit/jis-point.rb

@@ -0,0 +1,6 @@
+module TypographicUnit
+  # JISPoint is a unit of JIS point. JIS point is just same as American point.
+  class JISPoint < AmericanPoint
+    unit :jis_pt, AmericanPoint, 1
+  end
+end

data/lib/typographic-unit/meter.rb

@@ -0,0 +1,7 @@
+module TypographicUnit
+  # This is a class for representing meter(cm). Meter is defined as 100
+  # centimeter in this library.
+  class Meter < Unit
+    unit :m, Centimeter, 100
+  end
+end

data/lib/typographic-unit/millimeter.rb

@@ -0,0 +1,7 @@
+module TypographicUnit
+  # This is a class for representing millimeter(mm). Millimeter is defined as
+  # 10/254 inch in this library.
+  class Millimeter < Unit
+    unit :mm, Inch, Rational(10, 254)
+  end
+end

data/lib/typographic-unit/pica.rb

@@ -0,0 +1,7 @@
+module TypographicUnit
+  # This is a class for representing Pica(pc). Pica is defined as 12 tex point
+  # in this library.
+  class Pica < Unit
+    unit :pc, TeXPoint, 12
+  end
+end

data/lib/typographic-unit/postscript-point.rb

@@ -0,0 +1,7 @@
+module TypographicUnit
+  # This is a class for representing PostScript point(ps_pt). PostScript point
+  # is defined as 1 big point in this library.
+  class PostScriptPoint < Unit
+    unit :ps_pt, BigPoint, 1
+  end
+end

data/lib/typographic-unit/q.rb

@@ -0,0 +1,8 @@
+# -*- coding: utf-8 -*-
+
+module TypographicUnit
+  # Q is a unit of Japanese Q(級).
+  class Q < Unit
+    unit :q, Millimeter, Rational(25, 100)
+  end
+end

data/lib/typographic-unit/scaled-point.rb

@@ -0,0 +1,7 @@
+module TypographicUnit
+  # This is a class for representing scaled point(sp). Scaled point is defined
+  # as base unit in this library.
+  class ScaledPoint < Unit
+    unit :sp, self, 1
+  end
+end

data/lib/typographic-unit/tex-point.rb

@@ -0,0 +1,6 @@
+module TypographicUnit
+  # TeXPoint is a unit of TeX point. 1 TeX point equals 65536 scaled point.
+  class TeXPoint < Unit
+    unit :pt, ScaledPoint, 65536
+  end
+end

data/lib/typographic-unit/unit.rb

@@ -0,0 +1,261 @@
+module TypographicUnit
+  # This is a base class for all unit classes.
+  class Unit < ::Numeric
+    class << self
+      # @api private
+      def register(short, unit)
+        TypographicUnit::TABLE[short] = unit
+      end
+      private :register
+
+      # Define a unit. This method is used in concrete unit classes.
+      #
+      # @param short [Symbol]
+      #   short name for the unit
+      # @param base [Unit]
+      #   base unit class
+      # @param size [Rational]
+      #   unit size
+      # @return [void]
+      def unit(short, base, size)
+        @short = short
+        @base = base
+        @size = size
+        register(short, self)
+      end
+
+      # Return short name of the unit.
+      #
+      # @return [Symbol]
+      #   short name of the unit
+      def short
+        @short
+      end
+
+      # Return base unit class.
+      #
+      # @return [Class]
+      #   base unit class
+      def base
+        @base
+      end
+
+      # Return size of the unit.
+      #
+      # @return [Rational]
+      #   size of the unit
+      def size
+        @size
+      end
+    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.
+    #
+    # @return [ScaledPoint]
+    #   scaled point representation of the length
+    def scaled_point
+      val = self.class.base.new(@value * self.class.size)
+      val.kind_of?(ScaledPoint) ? val : val.scaled_point
+    end
+
+    # @api private
+    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.
+    #
+    # @param other [Unit]
+    #    target 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
+
+    alias :convert :>>
+
+    # Same as +Number#%+.
+    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
+
+    # Same as +Number#div+.
+    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
+
+    # Same as +Number#quo+.
+    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
+
+    # Same as Number#+@.
+    def +@
+      self.class.new(+@value)
+    end
+
+    # Same as +Number#-@+.
+    def -@
+      self.class.new(-@value)
+    end
+
+    # Same as +Number#abs+.
+    def abs
+      self.class.new(@value.abs)
+    end
+
+    # Perform addition.
+    #
+    # @param other [Unit]
+    #   additional value
+    # @return [Unit]
+    #   new value of the unit
+    # @example
+    #   1.cm + 1.mm #=> 1.1.cm
+    def +(other)
+      raise ArgumentError, other unless other.kind_of?(Unit)
+      self.class.new((@value + (other >> self.class).value).to_f)
+    end
+
+    # Perform subtraction.
+    #
+    # @param other [Unit]
+    #   subtractional value
+    # @return [Unit]
+    #   new value of the unit
+    # @example
+    #   1.cm - 1.mm #=> 0.9.cm
+    def -(other)
+      raise ArgumentError, other unless other.kind_of?(Unit)
+      self.class.new((@value - (other >> self.class).value).to_f)
+    end
+
+    # Same as +Number#*+.
+    def *(other)
+      raise ArgumentError, other unless other.kind_of?(Integer) or other.kind_of?(Float)
+      self.class.new(@value * other)
+    end
+
+    # Same as +Number#ceil+.
+    def ceil
+      self.class.new(@value.ceil)
+    end
+
+    # Same as +Number#floor+.
+    def floor
+      self.class.new(@value.floor)
+    end
+
+    # Same as +Number#round+.
+    def round
+      self.class.new(@value.round)
+    end
+
+    # Same as +Number#truncate+.
+    def truncate
+      self.class.new(@value.truncate)
+    end
+
+    # Same as +Number#integer?+.
+    def integer?
+      @value.integer?
+    end
+
+    # Same as +Number#nonzero?+.
+    def nonzero?
+      @value.nonzero?
+    end
+
+    # Convert to float representation.
+    #
+    # @return [Unit]
+    #   same unit but the value is float
+    # @example
+    #   1.cm.to_f #=> 1.0.cm
+    def to_f
+      self.class.new(@value.to_f)
+    end
+
+    # Convert to int representaion.
+    #
+    # @return [Unit]
+    #   same unit but the value is int
+    # @example
+    #   1.0.cm.to_i #=> 1.cm
+    def to_i
+      self.class.new(@value.to_i)
+    end
+
+    # Convert to int representation.
+    #
+    # @return [Unit]
+    #   same unit but the value is float
+    # @example
+    #   1.cm.to_f #=> 1.0.cm
+    def to_int
+      @value.to_i
+    end
+
+    # Same as +Number#zero?+.
+    def zero?
+      @value.zero?
+    end
+
+    # Same as +Number#step+ but you can specify +step+ as unit length.
+    #
+    # @param limit [Unit]
+    #   limit length
+    # @param step [Unit]
+    #   step
+    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
+
+    # Return string format.
+    def to_s
+      @value.to_s + self.class.short.to_s
+    end
+
+    # @api private
+    def inspect
+      "#<#{@value.to_s}#{self.class.short.to_s}>"
+    end
+
+    alias :eql? :"=="
+  end
+end

data/lib/typographic-unit/version.rb

@@ -1,9 +1,4 @@
 module TypographicUnit
-  module VERSION #:nodoc:
-    MAJOR = 0
-    MINOR = 1
-    TINY  = 1
-
-    STRING = [MAJOR, MINOR, TINY].join('.')
-  end
+  # Version number of typographic-unit.
+  VERSION = "0.2.0"
 end