iso_bsd-i18n 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ceef5f26f3ebeaf81508fb5a3728e993e5a286d6
+  data.tar.gz: 7e68f9db7ee9725eac6315515a4f00686674a166
+SHA512:
+  metadata.gz: cb845651fc8f40d60147b627bf39848e18e4bf06835216bc035b1ec3f87a08b5d7d0c839f7fcb4ccc150cdd5487d995b4f0edb8be3ad0040ecf4c1936583cc61
+  data.tar.gz: 8346cca19f8edd8357244d593ff791c0780fb29aaec8dfe44fc47f7b1e3b9a22c73ae473de5f8cc2dcecb31492b7b98f588369c2a00d0408abeb5547538c3db5

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,28 @@
+# rcov generated
+coverage
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+
+.localeapp/
+
+*~
+*.out
+*.project
+*.DS_Store
+*~
+.#*
+*#
+Gemfile.lock
+*.lock
+*.gem

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1 @@
+rvm: 1.9.2

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+
+

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 William Wedler
+
+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,40 @@
+# iso_bsd-i18n
+
+Text data for describing ISO Bead Seat Diameters for bicycle wheels.
+
+For background, see
+http://www.sheldonbrown.com/tire-sizing.html#isoetrto
+
+## Basic Usage
+
+        require 'iso_bsd-i18n'
+        
+        s = IsoBsdI18n::Size.new(622)
+        # Application(s)
+        s.app
+        # Traditional name(s)
+        s.trad
+        # Rarity information
+        s.rarity
+        # Test if common size
+        s.rarity.commmon?
+                
+        # SizeCollection of all sizes
+        c = IsoBsdI18n::Size.all
+
+        # SizeCollection of common sizes
+        # (based on default rarity divisions)
+        c = IsoBsdI18n::Rarity::default_division.common
+
+        my_divisions = {:common=>[bsd,..], :uncommon=>[bsd,..], :rare=>[bsd]}
+        
+        # Testing rarity based on specified divisions
+        s.rarity(my_divisions).common?
+        
+        # Override default rarity divisions
+        Rarity::default_division = my_divisions
+
+# License
+
+See license file.
+

data/Rakefile

@@ -0,0 +1,41 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec
+
+begin
+  # rake/rdoctask is deprecated in RDoc 2.4.2+
+  require 'rdoc/task'
+rescue LoadError
+  require 'rake/rdoctask'
+end
+
+require_relative './lib/iso_bsd-i18n'
+
+Rake::RDocTask.new do |rdoc|
+  version = IsoBsdI18n::VERSION
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "iso_bsd-i18n #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'i18n-spec/tasks'

data/iso_bsd-i18n.gemspec

@@ -0,0 +1,31 @@
+# encoding: utf-8
+$:.push File.expand_path("../lib", __FILE__)
+require 'iso_bsd-i18n/version'
+
+Gem::Specification.new do |s|
+  s.name = %q{iso_bsd-i18n}
+  s.version = IsoBsdI18n::VERSION
+  s.homepage = "http://freeridepg.org/"
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = [%q{William Wedler}]
+  s.date = %q{2012-11-09}
+  s.description = %q{Text describing bicycle wheel size information.}
+  s.email = %q{wedler.w@freeridepgh.org}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = `git ls-files`.split("\n")
+  s.licenses = [%q{MIT}]
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.6}
+  s.summary = %q{Text describing bicycle wheel size information. The purpose of this information is to assist in understanding and identifying a bicycle wheel size.}
+
+  s.add_development_dependency(%q<rake>, [">= 0"])
+  s.add_development_dependency(%q<rspec>, [">= 1.3.0"])
+  s.add_development_dependency(%q<i18n-spec>, [">= 0"])
+
+  s.add_runtime_dependency 'i18n', '>= 0', '>= 0'
+  s.add_runtime_dependency 'bundler', '~> 1.2', '~> 1.2'
+end
+

data/lib/iso_bsd-i18n.rb

@@ -0,0 +1,18 @@
+require 'i18n'
+require_relative 'iso_bsd-i18n/version'
+require_relative 'iso_bsd-i18n/size'
+require_relative 'iso_bsd-i18n/rarity'
+
+module IsoBsdI18n
+  def IsoBsdI18n::init
+    I18n.load_path << Dir[File.join(File.expand_path(File.dirname(__FILE__) + '/../locales'), '*.yml')]
+    I18n.load_path.flatten!
+  end
+
+  if defined?(Rails) 
+    require 'iso_bsd-i18n/iso_bsd-i18n_initializer.rb'
+  else
+    IsoBsdI18n::init
+  end
+
+end

data/lib/iso_bsd-i18n/division.rb

@@ -0,0 +1,58 @@
+require 'i18n'
+
+module IsoBsdI18n
+
+    # A Division encapsulates the classification of wheels into 
+    # specified non-intersecting groups.
+    class Division
+      
+      # @param [Hash, #each_pair] group_list Hash mapping division to array of sizes in the division
+      def initialize(group_list)
+        @raw_groups = group_list
+        @data = DivisionData.new(@raw_groups)
+        self.extend @data.to_mod
+      end
+
+      # @return [Hash] 
+      def hash
+        @raw_groups
+      end
+
+      def == (other)
+        @raw_groups == other.hash
+      end
+
+      private
+
+      # Defining methods on the fly for Division instances
+      # http://blog.jayfields.com/2008/02/ruby-dynamically-define-method.html
+      class DivisionData
+        def initialize(data)
+          @h = data
+          @h ||= {}
+          @groups = {} # holder for caching
+        end
+
+        def to_mod
+          h = @h
+          grps = @groups
+          Module.new do
+            h.each_pair do |gname, collection|
+              define_method gname do
+                col = grps[gname]
+                col ||= SizeCollection.new(collection)
+                grps[gname] = col
+              end
+              
+              define_method "#{gname}?" do |bsd|
+                col = grps[gname]
+                col ||= SizeCollection.new(collection)
+                col.include?(bsd)
+              end
+            end
+          end
+        end
+      end # class DivisionData
+
+    end # class Division
+end # module BsdIsoI18n

data/lib/iso_bsd-i18n/iso_bsd-i18n_initializer.rb

@@ -0,0 +1,7 @@
+module IsoBsdI18n
+  class Railtie < ::Rails::Railtie #:nodoc:
+    initializer 'rails-i18n' do |app|
+      IsoBsdI18n::init
+    end
+  end
+end

data/lib/iso_bsd-i18n/rarity.rb

@@ -0,0 +1,130 @@
+require 'i18n'
+require_relative 'size'
+require_relative 'division'
+
+module IsoBsdI18n
+
+  # Classify Size instances based on rarity.
+  # Used to help distinguish similar sizes.
+  # 
+  module Rarity
+
+    COMMON = [630, 622, 559, 507, 406, 305] unless defined?(COMMON)
+    UNCOMMON = [590, 597, 571] unless defined?(UNCOMMON)
+    RARE = [635, 599, 587, 584, 547, 540, 520,
+            490, 457, 451, 440, 419, 390, 369,
+            355, 349, 340, 337, 317, 203, 152, 137] unless defined?(RARE)
+
+    # The Division object used to classify size rarity.
+    # Used by default when explicit division is not specifed
+    # for Rarity functions.
+    #
+    # @return [Division]
+    def self.default_division
+      @default_division ||= Division.new(self.default_division_raw)
+      @default_division
+    end
+    
+    # Configure the default to specify rarity divisions.
+    # When nil is given, the default is defined based on 
+    # COMMON, UNCOMMON and RARE lists.
+    # 
+    # @param [Hash, Division, nil] d
+    def self.default_division=(d)
+      if d.class == Division
+        @default_division = d
+      else
+        d = nil unless d.respond_to?(:each_pair)
+        d ||= self.default_division_raw
+        @default_division = Division.new(d)
+      end
+      return @default_division
+    end
+
+    # Get the Hash to specify a default division based on 
+    # COMMON, UNCOMMON and RARE lists
+    # @return [Hash]
+    def self.default_division_raw
+      {
+        :common => COMMON,
+        :uncommon => UNCOMMON,
+        :rare => RARE
+      }
+    end
+
+    # Get the sizes of the given rarity
+    # 
+    # @params [Symbol, String] rarity
+    # @params [Division] division
+    # @return [SizeCollection]
+    def self.get(rarity, division=nil)
+      division ||= default_division
+      division.send(rarity)
+    end
+
+    # Rarity value object to be used as an attribute to Size instances
+    # 
+    class Value
+      
+      # @param [Integer] bsd
+      # @param [Division, #each_pair] division rarity classifications
+      def initialize(bsd, division=nil)
+        @bsd = bsd
+        self.division=division
+        @data = ValueData.new(@bsd, @division)
+        self.extend @data.to_mod
+      end
+
+      # @return [String] Translated rarity
+      def to_s
+        str = nil
+        @division.hash.keys.each do |k|
+          if self.send("#{k}?")
+            str = I18n.translate("isobsd.rarity.#{k}")
+          end
+        end
+        str ||= AttribNoData.new
+
+        return str
+      end
+
+      private 
+
+      # Initialize the Division object used to test for rarity
+      # 
+      def division=(div)
+        @division = div if div.class == Division
+        @division ||= Division.new(div) if div.respond_to?(:each_pair)
+        @division ||= Rarity::default_division
+      end
+
+      # Defining methods on the fly for Value instances
+      class ValueData
+        def initialize(bsd, division)
+          @diameter = bsd
+          @div = division
+          @membership = {}
+        end
+
+        # @return [Module] A Value instance extends on initialization
+        def to_mod
+          div = @div
+          h = div.hash
+          diam = @diameter
+          mem = @membership
+          Module.new do
+            h.each_pair do |gname, collection|
+              define_method "#{gname}?" do
+                mem[gname] ||= div.send("#{gname}?", diam)
+                mem[gname]
+              end
+            end # h.each_pair do
+          end
+        end
+      end # class ValueData
+      
+    end # class Value
+
+  end # module Rarity
+
+end

data/lib/iso_bsd-i18n/size.rb

@@ -0,0 +1,244 @@
+require 'i18n'
+
+module IsoBsdI18n
+
+  class AttribNoData < String
+    def initialize(str = nil)
+      str ||= I18n.translate('isobsd.messages.not_applicable')
+      super(str)
+    end
+
+    def capitalize
+      self.to_s
+    end
+  end
+
+  class SizeUnknown < String
+    def initialize(bsd)
+      @bsd = bsd
+      super(I18n.translate('isobsd.messages.unknown'))
+    end
+  end
+
+  class Size
+
+    # @param [Integer] bsd
+    # 
+    def initialize(bsd)
+      @bsd = bsd
+    end
+
+    # Test if the given BSD value maps to known size data
+    # 
+    # @param [Integer, #to_i] val
+    # 
+    # @return [Boolean]
+    def self.unknown?(val)
+      !I18n.translate('isobsd.sizes').has_key?(val.to_i)
+    end
+
+    # Test if this size is unknown
+    # 
+    # @return [Boolean]
+    def unknown?
+      Size.unknown?(@bsd)
+    end
+
+    # @return [String] The bsd as string.
+    #
+    def to_s
+      @bsd.to_s
+    end
+
+    def to_sym
+      @bsd.to_s.to_sym
+    end
+
+
+    # @return [Integer] The bsd for this size.
+    # 
+    def to_i
+      @bsd.to_i
+    end
+
+    def <=>(other)
+      self.to_i <=> other.to_i
+    end
+
+    # @return [String] The bsd and units like 622mm
+    #
+    def diameter
+      @diam ||= "#{@bsd}mm"
+      @diam
+    end
+
+    # Traditional name or names of this size
+    # @return [String, Array] 
+    def trad
+      lookup(:trad)
+    end
+
+    # Appliication(s) of this size
+    # @return [String, Array]
+    def app
+      lookup(:app)
+    end
+
+    # Rarity of the size given rarity divisions
+    #
+    # @param [Division, #each_pair] rarity_data rarity classifications
+    # 
+    def rarity(rarity_data = nil)
+      if rarity_data.nil?
+        # Only cache when default rarity being used
+        @rarity ||= Rarity::Value.new(@bsd, rarity_data)
+        return @rarity
+      else
+        return Rarity::Value.new(@bsd, rarity_data)
+      end
+    end
+
+    # Provides a hash containing all attributes
+    # 
+    # @return [Hash] of size attributes
+    def hash
+      {
+        :diameter => self.diameter,
+        :app => self.app,
+        :trad => self.trad,
+        :rarity => self.rarity.to_s
+      }  
+    end
+
+    # @return [Array] All size information in an Array of Size objects
+    def Size.all
+      @all ||= SizeCollection.new(I18n.translate('isobsd.sizes').keys)
+      @all 
+    end
+
+    private
+
+    # Lookup the attribute for the given key
+    # Returns an Array if multiple values map the the attribute
+    #
+    # @param [Symbol] key Attribute to lookup
+    # @return [String, Array]
+    def lookup(key)
+      if unknown?
+        return data
+      end
+
+      val = data[key]
+      val ||= AttribNoData.new
+
+      # Convert multi-lined entries to an array
+      if val.class == Hash
+        val = val.values
+      end
+
+      return val
+    end
+
+    # Wrapper for the I18n::translate call to retrieve wheel size data
+    # @return [Hash] 
+    def data
+      @data ||= (unknown?) ? SizeUnknown.new(@bsd) : I18n.translate("isobsd.sizes")[@bsd]
+      @data
+    end
+
+  end # class Size
+
+  class SizeCollection
+
+    include Enumerable
+
+    # @param [Array] data List of sizes to include in the collection
+    def initialize(data=[])
+      @list = data
+    end
+
+    # Array of size objects in the collection
+    # 
+    # @return [Array]
+    def sizes
+      select_sizes(@list)
+    end
+
+    def each
+      self.sizes.each do |s|
+        yield s
+      end
+    end
+
+    # Test if the given size is in the collection
+    #
+    # @param [Size, #==] val
+    #
+    # @return [Boolean]
+    def include?(val)
+      @list.include?(val)
+    end
+
+    # A nested hash of structure
+    # { size.diameter => size.hash ,... }
+    # 
+    # @return (Hash) 
+    def hash
+      Hash[sizes.map{|s| [s.to_i, s.hash]}]
+    end
+
+    # @param [Array] locales String array specifying locales to include
+    # @return [Hash] The hash for each Size in the collection for each locale specified
+    def hash_locale(locales=nil)
+      orig_locale = I18n.locale
+      h = {}
+
+      if(locales.nil? || locales.empty?)
+        locales = I18n::available_locales
+      end
+
+      begin
+        locales.each do |l|
+          begin
+            if ! I18n.translate('isobsd', :raise => true, :locale => l).nil?
+              I18n.locale = l
+              h[l] = self.hash
+            end
+          rescue
+          end
+        end
+      ensure
+        I18n.locale = orig_locale
+      end
+      return h
+    end
+
+    # Hash of structure
+    # {size.bsd => size.diameter, ... }
+    #
+    #  @return [Hash]
+    def labels
+      Hash[sizes.map{|s| [s.to_s, s.diameter]}]
+    end
+
+    # Array of size.hash
+    # 
+    # @return [Array]
+    def to_data
+      sizes.map{|s| {:id=>s.to_s, :text=>s.diameter}}
+    end
+
+    private
+
+    # @param [Array] targets List of sizes to include
+    # @param [Hash] size_data Data set to build Size objects from
+    # @return [Array] of Size objects
+    def select_sizes(targets=nil,size_data=nil)
+      size_data ||= I18n.translate('isobsd.sizes')
+      group = size_data.select{|k,v| (targets.include? k)} unless targets.nil?
+      group ||= size_data
+      group.keys.map{|k| Size.new(k)}
+    end
+  end # class SizeCollection
+
+end