rose 0.0.5

data/.autotest

@@ -0,0 +1,3 @@
+Autotest.add_hook :initialize do |at|
+  at.add_exception('spec/log')
+end

data/.document

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

data/.gitignore

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 hsume2
+
+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.markdown

@@ -0,0 +1,271 @@
+# rose
+
+Rose (say it out loud: rows, rows, rows) is a slick Ruby DSL for reporting:
+
+    Rose.make(:worlds) do
+      rows do
+        column(:hello => "Hello")
+        column(:world)
+      end
+    end
+
+    class World < Struct.new(:hello, :world)
+    end
+
+    Rose(:worlds).bloom([World.new("Say", "what?")]).to_s
+
+    +---------------+
+    | Hello | world |
+    +---------------+
+    | Say   | what? |
+    +---------------+
+
+Install the gem:
+
+    gem install rose
+
+
+*****
+
+# Usage
+
+## Making a Report
+
+    class Flower < Struct.new(:type, :color, :age)
+    end
+
+    Rose.make(:poem, :class => Flower) do
+      rows do
+        column(:type => "Type")
+        column("Color", &:color)
+      end
+    end
+
+## Running a Report
+
+    Rose(:poem).bloom([Flower.new(:roses, :red), Flower.new(:violets, :blue)])
+
+    +-----------------+
+    |  Type   | Color |
+    +-----------------+
+    | roses   | red   |
+    | violets | blue  |
+    +-----------------+
+
+## Sorting
+
+    Rose.make(:with_sort_by_age_descending, :class => Flower) {
+      rows do
+        column(:type => "Type")
+        column(:color => "Color")
+        column(:age => "Age")
+      end
+      sort("Age", :descending)
+    }
+
+## Filtering
+
+    Rose.make(:with_filter, :class => Flower) {
+      rows do
+        column(:type => "Type")
+        column(:color => "Color")
+        column(:age => "Age")
+      end
+      filter do |row|
+        row["Color"] != "blue"
+      end
+    }
+
+## Summarizing
+
+    Rose.make(:with_summary, :class => Flower) {
+      rows do
+        column(:type => "Type")
+        column(:color => "Color")
+      end
+      summary("Type") do
+        column("Color") { |colors| colors.uniq.join(", ") }
+        column("Count") { |colors| colors.size }
+      end
+    }
+
+## Pivoting
+
+    Rose.make(:with_pivot, :class => Flower) {
+      rows do
+        column(:type => "Type")
+        column(:color => "Color")
+        column(:age => "Age")
+      end
+      pivot("Color", "Type") do |rows|
+        rows.map(&:Age).map(&:to_i).inject(0) { |sum,x| sum+x }
+      end
+    }
+
+## Importing
+
+    Rose.make(:with_find_and_update) do
+      rows do
+        identity(:id => "ID")
+        column(:type => "Type")
+        column(:color => "Color")
+        column(:age => "Age")
+      end
+      roots do
+        # find is optional. By default will return items with item["ID"] == idy
+        find do |items, idy|
+          items.find { |item| item.id.to_s == idy }
+        end
+        update do |item, updates|
+          item.color = updates["Color"]
+        end
+      end
+    end
+
+`#identity` must be used for one column. Without it `Rose` won't be able to identify which items to update.
+
+### Manually
+
+    Rose(:with_find_and_update).photosynthesize(@flowers, {
+      :updates => {
+        "0" => { "Color" => "blue" }
+        # ID => Updates
+      }
+    })
+
+### CSV
+
+    Rose(:with_find_and_update).photosynthesize(@flowers, {
+      :csv_file => "change_flowers.csv"
+    })
+
+### Preview
+
+    Rose.make(:with_preview) do
+      rows do
+        identity(:id => "ID")
+        column(:type => "Type")
+        column(:color => "Color")
+        column(:age => "Age")
+      end
+      roots do
+        preview_update do |item, updates|
+          item.preview(true); item.color = updates["Color"]
+        end
+        update { raise Exception, "you shouldn't be calling me" }
+      end
+    end
+
+    Rose(:with_preview).photosynthesize(@flowers, {
+      :updates => {
+        "0" => { "Color" => "blue" }
+      },
+      :preview => true
+    })
+
+    Rose(:with_preview).photosynthesize(@flowers, {
+      :csv_file => "change_flowers.csv",
+      :preview  => true
+    })
+
+# ActiveRecord
+
+First, use the ActiveRecord adapter:
+
+    config.gem 'rose', :lib => 'rose/active_record'
+
+For the most part, the ActiveRecord adapter has the same interface as the ObjectAdapter, except for the following differences:
+
+## Making a Report
+
+    Employee.rose(:department_salaries) do
+      rows do
+        column("Name") { |e| "#{e.firstname} #{e.lastname}" }
+        column("Department") { |e| e.department.name }
+        column("Salary") { |e| e.salary }
+      end
+      summary("Department") do
+        column("Salary") { |salaries| salaries.map(&:to_i).sum }
+      end
+    end
+
+## Running a Report
+
+    Employee.rose_for(:department_salaries, :conditions => ["salary <> ?", nil])
+
+    +----------------------+
+    | Department  | Salary |
+    +----------------------+
+    | Accounting  |  85000 |
+    | Admin       |  69000 |
+    | Sales       | 120000 |
+    | Engineering | 122000 |
+    | IT          |  50000 |
+    | Graphics    |  42000 |
+    +----------------------+
+
+`Employee#rose_for` is a helper method that blooms on Employee.find(:all, :conditions => ["salary <> ?", nil]). If you still want direct access to your report, you can use `Employee.seedlings(:department_salaries)`
+
+## Importing (with Preview)
+
+    Post.rose(:for_update) {
+      rows do
+        identity(:guid => "ID")
+        column("Title", &:title)
+        column("Comments") { |item| item.comments.size }
+      end
+
+      sort("Comments", :descending)
+
+      roots do
+        find do |items, idy|
+          items.find { |item| item.guid == idy }
+        end
+        preview_create do |idy, updates|
+          post = Post.new(:guid => idy)
+          post.title = updates["Title"]
+          post
+        end
+        create do |idy, updates|
+          post = create_previewer.call(idy, updates)
+          post.save!
+          post
+        end
+        preview_update do |record, updates|
+          record.title = updates["Title"]
+        end
+        update do |record, updates|
+          record.update_attribute(:title, updates["Title"])
+        end
+      end
+    }
+
+    Post.root_for(:for_update, {
+      :with => {
+        "1" => { "Title" => "New Title" }
+      },
+      :preview => true
+    }) # => Returns a table
+
+    Post.root_for(:for_update, {
+      :with => "change_flowers.csv"
+      :preview  => true
+    })
+
+*****
+
+# Other
+
+Inspired by `Machinist` and `factory_girl`
+
+*****
+
+# Future
+
+* Documentation
+
+*****
+
+# Copyright
+
+Copyright (c) 2010 Henry Hsu. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,85 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rose"
+    gem.summary = %Q{Reporting like a spring rose, rows and rows of it}
+    gem.description = %Q{A slick Ruby DSL for reporting.}
+    gem.email = "henry@qlane.com"
+    gem.homepage = "http://github.com/hsume2/rose"
+    gem.authors = ["Henry Hsu"]
+    gem.add_dependency "ruport", ">= 1.6.3"
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "yard", ">= 0"
+    gem.add_development_dependency "cucumber", ">= 0"
+    # 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 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+  spec.rcov_opts << %w{--exclude osx\/objc,gems\/,spec\/,features\/}
+end
+
+task :spec => :check_dependencies
+
+begin
+  require 'cucumber/rake/task'
+  Cucumber::Rake::Task.new(:features)
+
+  task :features => :check_dependencies
+rescue LoadError
+  task :features do
+    abort "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
+  end
+end
+
+begin
+  require 'reek'
+  require 'reek/rake/task'
+  Reek::Rake::Task.new do |t|
+    t.fail_on_error = true
+    t.verbose = false
+    t.source_files = 'lib/**/*.rb'
+  end
+rescue LoadError
+  task :reek do
+    abort "Reek is not available. In order to run reek, you must: sudo gem install reek"
+  end
+end
+
+begin
+  require 'roodi'
+  require 'roodi_task'
+  RoodiTask.new do |t|
+    t.verbose = false
+  end
+rescue LoadError
+  task :roodi do
+    abort "Roodi is not available. In order to run roodi, you must: sudo gem install roodi"
+  end
+end
+
+task :default => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.5

data/features/rose.feature

@@ -0,0 +1,9 @@
+Feature: something something
+  In order to something something
+  A user something something
+  something something something
+
+  Scenario: something something
+    Given inspiration
+    When I create a sweet new gem
+    Then everyone should see how awesome I am

data/features/support/env.rb

@@ -0,0 +1,4 @@
+$:.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'rose'
+
+require 'spec/expectations'

data/lib/rose.rb

@@ -0,0 +1,33 @@
+require 'ruport'
+
+module Rose
+  autoload :Seedling, 'rose/seedling'
+  autoload :Shell, 'rose/shell'
+  autoload :ObjectAdapter, 'rose/object'
+  autoload :ActiveRecordAdapter, 'rose/active_record'
+  autoload :CoreExtensions, 'rose/core_extensions'
+
+  class << self
+    # @return [Hash] global hash of all the named seedlings
+    attr_accessor :seedlings
+  end
+
+  self.seedlings = {}
+
+  # The generate Rose DSL builder
+  # @param [Symbol] name the name of the Seedling to make
+  # @param [Hash] options 
+  # @option options [Class] :class (nil) Used during by the adapter to enforce items types
+  # @return [Rose::Seedling] the newly formed Seedling
+  def self.make(name, options={}, &blk)
+    instance = Rose::Seedling.new(Rose::ObjectAdapter, options)
+    instance.instance_eval(&blk)
+    self.seedlings[name] = Shell.new(instance)
+  end
+end
+
+# @param [Symbol] name the name of the seedling
+# @return [Rose::Seedling] find seedling by name and returns it
+def Rose(name)
+  Rose.seedlings[name]
+end