collection 0.0.1

data/.document

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

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Michael Aufreiter
+
+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,42 @@
+Collection API
+================================================================================
+
+A Ruby API for the [Unveil.js](http://github.com/michael/unveil/) collection
+interface. Useful for exporting all kinds of data in a uniform Collection format.
+
+
+Usage
+--------------------------------------------------------------------------------
+
+    c = Collection.new
+    c.property(:customer, {:name => "Customer", :type => String, :unique => true })
+    c.property(:product,  {:name => "Product", :type => String, :unique => true })
+    c.property(:quantity, {:name => "Salesman", :type => Numeric, :unique => true })
+    c.property(:price,    {:name => "Price", :type => Numeric, :unique => true })
+    
+    c.add("IO47181", {
+      :customer => "John Smith",
+      :product  => "XT52",
+      :quantity => 21,
+      :price    => 231.5
+    })
+    
+    c.to_json => A JSON string that conforms to an Unveil.js Collection
+    c.to_csv => Plain old CSV representation, if your clients can't get around Excel :/
+
+
+Note on Patches/Pull Requests
+--------------------------------------------------------------------------------
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+Copyright
+--------------------------------------------------------------------------------
+
+Copyright (c) 2010 Michael Aufreiter. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "collection"
+    gem.summary = %Q{A Ruby API for the Unveil.js collection interface}
+    gem.description = %Q{}
+    gem.email = "ma@zive.at"
+    gem.homepage = "http://github.com/michael/collection"
+    gem.authors = ["Michael Aufreiter"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "collection #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/collection.gemspec

@@ -0,0 +1,51 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{collection}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Michael Aufreiter"]
+  s.date = %q{2010-07-27}
+  s.description = %q{}
+  s.email = %q{ma@zive.at}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "collection.gemspec",
+     "lib/collection.rb",
+     "test/helper.rb",
+     "test/test_collection.rb"
+  ]
+  s.homepage = %q{http://github.com/michael/collection}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{A Ruby API for the Unveil.js collection interface}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_collection.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/lib/collection.rb

@@ -0,0 +1,184 @@
+require 'rubygems'
+require 'json'
+require 'date'
+require 'fastercsv'
+
+# Collection API
+# ==============================================================================
+# 
+# Usage:
+# 
+# c = Collection.new
+# c.property(:customer, {:name => "Customer", :type => String, :unique => true })
+# c.property(:product, {:name => "Product", :type => String, :unique => true })
+# c.property(:quantity, {:name => "Salesman", :type => Numeric, :unique => true })
+# c.property(:price, {:name => "Price", :type => Numeric, :unique => true })
+# 
+# c.add("IO47181", {
+#   :customer => "John Smith",
+#   :product => "XT52",
+#   :quantity => 21,
+#   :price => 231.5
+# })
+#
+# c.to_json
+# c.to_csv
+#
+
+
+class Collection
+  
+  class PropertyExists        < StandardError ; end
+  class PropertyNotFound      < StandardError ; end
+  
+  
+  module Formatters
+    def self.number_to_currency(number, options = {})
+        precision = options[:precision] || 2
+        unit      = options[:unit] || ""
+        separator = precision > 0 ? options[:separator] || "." : ""
+        delimiter = options[:delimiter] || ""
+        format    = options[:format] || "%u%n"
+      begin
+        parts = number_with_precision(number, precision).split('.')
+        format.gsub(/%n/, number_with_delimiter(parts[0], delimiter) + separator + parts[1].to_s).gsub(/%u/, unit)
+      rescue
+        number
+      end
+    end
+    
+    def self.number_with_delimiter(number, delimiter=",", separator=".")
+      begin
+        parts = number.to_s.split('.')
+        parts[0].gsub!(/(\d)(?=(\d\d\d)+(?!\d))/, "\\1#{delimiter}")
+        parts.join separator
+      rescue
+        number
+      end
+    end
+    
+    def self.number_with_precision(number, precision=3)
+      "%01.#{precision}f" % ((Float(number) * (10 ** precision)).round.to_f / 10 ** precision)
+    rescue
+      number
+    end
+  end
+  
+  class Property
+    attr_accessor :key, :name, :type, :descr, :collection
+
+    def initialize(collection, key, options)
+      @collection, @key = collection, key
+      @name = options[:name]
+      @type = options[:type]
+      @descr = options[:descr]
+      @unique = options[:unique]
+    end
+    
+    def type_as_string
+      if type.kind_of?(Numeric)
+        "number"
+      elsif type.kind_of?(Date)
+        "date"
+      else
+        "string"
+      end
+    end
+    
+    def to_hash
+      {
+        :name => @name,
+        :type => type_as_string,
+        :descr => @descr.to_s,
+        :unique => @unique
+      }
+    end
+    
+    def unique?
+      @unique
+    end
+  end
+  
+  class Item
+    attr_accessor :values
+    
+    def initialize(collection, key, values)
+      @collection, @key, @values = collection, key, values
+    end
+    
+    def value(property_key)
+      raise PropertyNotFound unless @collection.properties.key?(property_key)
+      @values[property_key]
+    end
+  end
+  
+  attr_reader :properties
+  attr_reader :items
+  
+  def initialize
+    @properties = {}
+    @items = {}
+    
+    # preserve the insertion order
+    @property_keys = []
+    @item_keys = []
+  end
+  
+  def property(key, options)
+    @properties[key] = Property.new(self, key, options)
+    @property_keys << key
+  end
+  
+  def add(key, item)
+    @items[key] = Item.new(self, key, item)
+    @item_keys << key
+  end
+  
+  def remove(key)
+    @items.delete(key)
+  end
+  
+  def to_json
+    result = {:properties => {}, :items => {}}
+    
+    @property_keys.each do |key|
+      result[:properties][key] = @properties[key].to_hash
+    end
+    
+    @item_keys.each do |key|
+      result[:items][key] = @items[key].values
+    end
+    
+    JSON.pretty_generate(result)
+  end
+  
+  def to_csv(options = { :col_sep => ',', :number_delimiter => '', :number_separator => '.' })
+    csv_options = options.clone
+    csv_options.delete(:number_delimiter)
+    csv_options.delete(:number_separator)
+    
+    FasterCSV.generate(csv_options) do |csv|
+      # Add headers
+      headers = []
+      @property_keys.each do |key|
+        headers << @properties[key].name
+      end
+      csv << headers
+      
+      # Add data rows
+      @item_keys.each do |item_key|
+        row_data = []
+        @property_keys.each do |property_key|
+          val = @items[item_key].value(property_key)
+          if val.kind_of?(Numeric)
+            row_data << Formatters.number_to_currency(val, :separator => options[:number_separator], :delimiter => options[:number_delimiter])
+          else
+            row_data << val
+          end
+        end
+        csv << row_data
+      end
+      
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'collection'
+
+class Test::Unit::TestCase
+end

data/test/test_collection.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestCollection < Test::Unit::TestCase
+  def test_something_for_real
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: collection
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Michael Aufreiter
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-27 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: ""
+email: ma@zive.at
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- collection.gemspec
+- lib/collection.rb
+- test/helper.rb
+- test/test_collection.rb
+has_rdoc: true
+homepage: http://github.com/michael/collection
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A Ruby API for the Unveil.js collection interface
+test_files: 
+- test/helper.rb
+- test/test_collection.rb