label_definitions 1.0.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Andy Stewart
+
+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,46 @@
+# Label Definitions
+
+An open source list of label dimensions.  The data are in [labels.yml](./labels.yml).
+
+Surprisingly Avery doesn't publish a structured list of their labels.  Even more surprisingly, I can't find a good list on the internet.  So here's a start.
+
+Avery has so many labels that I add them here on an as-needed basis.  Feel free to open a pull request for additional labels (supplying the dimensions).
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'label_definitions'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install label_definitions
+
+
+## Usage
+
+```ruby
+# Get all the labels
+LabelDefinitions.all
+# => [ #<Label>, ... ]
+
+# Get a specific label
+LabelDefinitions.find 'Avery 5160'
+# => #<Label @name='Avery 5160', ...>
+
+# Add a custom label (not persisted)
+custom = Label.new name: 'Custom', ...
+LabelDefinitions.add custom
+LabelDefinitions.find 'Custom'
+# => #<Label @name='Custom', ...>
+```
+
+
+## Intellectual Property
+
+Copyright 2013 Andrew Stewart, AirBlade Software Ltd.  Released under the MIT licence.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+task default: :test
+
+Rake::TestTask.new do |t|
+  # t.libs << 'test'
+  t.pattern = 'test/*_test.rb'
+end

data/label_definitions.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'label_definitions/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "label_definitions"
+  spec.version       = LabelDefinitions::VERSION
+  spec.authors       = ["Andy Stewart"]
+  spec.email         = ["boss@airbladesoftware.com"]
+  spec.description   = 'Open source list of label sizes.'
+  spec.summary       = 'Open source list of label sizes.'
+  spec.homepage      = 'https://github.com/airblade/label_definitions'
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'minitest', '~> 5'
+end
+
+

data/labels.yml

@@ -0,0 +1,56 @@
+# Listed alphabetically.
+# Labels with the same dimensions are listed once with aliases.
+# Specify either page_size or (page_width and page_height).
+# Dimensions in millimetres.
+
+Avery 3657:
+  rows: 10
+  columns: 4
+  width: 48.5
+  height: 25.4
+  row_gutter: 0.0
+  column_gutter: 0.0
+  page_size: A4
+Avery 5160:
+  rows: 10
+  columns: 3
+  width: 66.675
+  height: 25.4
+  row_gutter: 0.0
+  column_gutter: 3.175
+  page_size: Letter
+Avery 5395:
+  rows: 4
+  columns: 2
+  width: 85.725
+  height: 59.267
+  row_gutter: 4.0527
+  column_gutter: 9.5
+  page_size: Letter
+Avery 5418:
+  rows: 9
+  columns: 4
+  width: 19.05
+  height: 12.7
+  row_gutter: 1.6
+  column_gutter: 1.6
+  page_width: 101.6
+  page_height: 152.4
+Avery J8651:
+  aliases: Avery L7651
+  rows: 13
+  columns: 5
+  width: 38.1
+  height: 21.2
+  row_gutter: 0.0
+  column_gutter: 2.5
+  page_size: A4
+Zweckform 4737:
+  aliases: Zweckform 4784
+  rows: 9
+  columns: 3
+  width: 63.5
+  height: 29.6
+  row_gutter: 0.0
+  column_gutter: 2.54
+  page_size: A4

data/lib/label_definitions/label.rb

@@ -0,0 +1,24 @@
+module LabelDefinitions
+  class Label
+    attr_reader :name, :rows, :columns, :width, :height, :row_gutter, :column_gutter,
+                :page_size, :page_width, :page_height
+
+    def initialize(attributes = {})
+      @name          = attributes.fetch(:name)
+      @rows          = attributes.fetch(:rows).to_i
+      @columns       = attributes.fetch(:columns).to_i
+      @width         = attributes.fetch(:width).to_f
+      @height        = attributes.fetch(:height).to_f
+      @row_gutter    = attributes.fetch(:row_gutter).to_f
+      @column_gutter = attributes.fetch(:column_gutter).to_f
+      if attributes.has_key? :page_size
+        @page_size   = attributes.fetch(:page_size)
+      else
+        @page_width  = attributes.fetch(:page_width).to_f
+        @page_height = attributes.fetch(:page_height).to_f
+      end
+    end
+
+
+  end
+end

data/lib/label_definitions/version.rb

@@ -0,0 +1,3 @@
+module LabelDefinitions
+  VERSION = '1.0.0'
+end

data/lib/label_definitions.rb

@@ -0,0 +1,45 @@
+require 'yaml'
+require 'label_definitions/label'
+require 'label_definitions/version'
+
+module LabelDefinitions
+
+  def self.all
+    @labels ||= begin
+      labels = []
+      load_definitions.each do |name, definition|
+        symbolize_keys! definition
+        name_and_aliases(name, definition).each do |n|
+          labels << Label.new(definition.merge({name: n}))
+        end
+      end
+      labels
+    end
+  end
+
+  def self.find(name)
+    all.detect { |label| label.name == name }
+  end
+
+  # Adds a label definition to the in-memory list.  Does not persist it.
+  def self.add(label)
+    find(label.name) || (all << label)
+  end
+
+  private
+
+  def self.name_and_aliases(name, definition)
+    [name] + definition.fetch(:aliases, '').split(',').map(&:strip)
+  end
+
+  def self.load_definitions
+    YAML.load_file File.expand_path('../../labels.yml', __FILE__)
+  end
+
+  def self.symbolize_keys!(hash)
+    hash.keys.each do |key|
+      hash[key.to_sym] = hash.delete key
+    end
+    hash
+  end
+end

data/test/helper.rb

@@ -0,0 +1,8 @@
+gem 'minitest'
+require 'minitest/autorun'
+
+class TestCase < Minitest::Test
+  def self.test(name, &block)
+    define_method :"test_#{name.inspect}", &block
+  end
+end

data/test/label_definitions_test.rb

@@ -0,0 +1,54 @@
+require_relative 'helper'
+require 'label_definitions'
+
+class LabelDefinitionsTest < TestCase
+
+  def setup
+    LabelDefinitions.instance_variable_set '@labels', nil
+  end
+
+  test 'all' do
+    labels = LabelDefinitions.all
+    assert_same labels, LabelDefinitions.all  # caching
+    assert_equal 8, labels.length
+    assert_kind_of LabelDefinitions::Label, labels.first
+  end
+
+  test 'find' do
+    label = LabelDefinitions.find 'Zweckform 4737'
+    assert_equal 9, label.rows
+  end
+
+  test 'find alias' do
+    label = LabelDefinitions.find 'Zweckform 4784'
+    assert_equal 9, label.rows
+  end
+
+  test 'add custom label' do
+    custom = example_label
+    LabelDefinitions.add custom
+    label = LabelDefinitions.find 'Custom'
+    assert_same custom, label
+  end
+
+  test 'add custom label ignores duplicates' do
+    LabelDefinitions.add example_label
+    count = LabelDefinitions.all.length
+    LabelDefinitions.add example_label
+    assert_equal count, LabelDefinitions.all.length
+  end
+
+  private
+
+  def example_label
+    LabelDefinitions::Label.new name: 'Custom',
+                                rows: 3,
+                                columns: 5,
+                                width: 153,
+                                height: 42,
+                                row_gutter: 0,
+                                column_gutter: 0,
+                                page_size: 'A4'
+  end
+
+end

data/test/label_test.rb

@@ -0,0 +1,24 @@
+require_relative 'helper'
+require 'label_definitions/label'
+
+class LabelTest < TestCase
+
+  test 'requires page size or (page width and height)' do
+    assert_raises(KeyError) { LabelDefinitions::Label.new attributes }
+    assert LabelDefinitions::Label.new(attributes.merge(page_size: 'A4'))
+    assert LabelDefinitions::Label.new(attributes.merge(page_width: 42, page_height: 153))
+  end
+
+  private
+
+  def attributes
+    { name: 'Some label',
+      rows: 3,
+      columns: 5,
+      width: 153,
+      height: 42,
+      row_gutter: 0,
+      column_gutter: 0 }
+  end
+end
+

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: label_definitions
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Andy Stewart
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5'
+description: Open source list of label sizes.
+email:
+- boss@airbladesoftware.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- label_definitions.gemspec
+- labels.yml
+- lib/label_definitions.rb
+- lib/label_definitions/label.rb
+- lib/label_definitions/version.rb
+- test/helper.rb
+- test/label_definitions_test.rb
+- test/label_test.rb
+homepage: https://github.com/airblade/label_definitions
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3975846568932287638
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3975846568932287638
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Open source list of label sizes.
+test_files:
+- test/helper.rb
+- test/label_definitions_test.rb
+- test/label_test.rb