rails-excel 0.0.1 → 0.0.2

data/Changelog

@@ -0,0 +1,9 @@
+2011-08-23 12:19  Ramihajamalala Hery <hery@weborama.com> v0.0.2
+
+	* Add a todo list
+	* Allow to set excel strategy per action basis
+
+2011-08-22 10:19  Ramihajamalala Hery <hery@weborama.com> v0.0.1
+
+	* First working release
+

data/README.md

@@ -0,0 +1,92 @@
+# Rails Excel
+
+It adds support of .rxls templates for your rails views
+
+It comes with two builtin strategies based on the very good gems [writeexcel](https://github.com/cxn03651/writeexcel) and [spreadsheet](http://spreadsheet.rubyforge.org/index.html)
+
+# Requirements
+
+* rails ~> '2.3.0'
+* ruby ~> '1.8.6'
+
+
+# Usage
+
+In your config/environment.rb
+
+    config.gem 'rails-excel'
+
+
+Create an initializer : config/initializers/excel.rb
+
+    Rails::Excel.configure do |config|
+      config.strategy = :spreadsheet # by default or :write_excel
+    end
+
+
+If you wan tot implement your own strategy, here are the requirements :
+
+* Must respond to compile
+* First argument of compile takes a StringIo instance where to write the response
+* compile takes a block that yields a workbook instance
+
+
+Example extracted from code source:
+
+    # lib/my_strategy.rb
+
+    class MyStrategy
+      def compile(io, &block)
+        workbook = ::Spreadsheet::Workbook.new
+        yield(workbook)
+        workbook.write(io)
+      end
+    end
+
+Then in your config/initializers/excel.rb
+
+
+    require 'my_strategy'
+    Rails::Excel.configure do |config|
+      config.add_strategy :my_strategy, MyStrategy.new
+      # Redefining default strategy
+      config.strategy = :my_strategy # by default it was :spreadsheet
+    end
+
+You can use any object as long as it responds to described `compile` method
+
+
+The strategy defined in the initializer will be used in all of your controllers
+
+To use another strategy you can set it by controller :
+
+    class UsersController < ApplicationController
+      self.excel_strategy = :write_excel
+    end
+
+
+Or you can set strategy per action by redefining instance method excel_strategy
+
+    class UsersController < ApplicationController
+
+      self.excel_strategy = :write_excel
+
+      def index
+        # ...
+      end
+
+      def show
+        # ...
+      end
+
+      protected
+      def excel_strategy
+        case action_name
+        when 'index'
+          :spreadsheet
+        else
+          self.class.excel_strategy
+        end
+      end
+
+    end

data/TODO.md

@@ -0,0 +1,6 @@
+# TODO list
+
+* Implement tests
+* Allow to use with rails >= 2.3.0
+* Add more strategies like roo
+

data/lib/rails-excel/delegation.rb

@@ -14,6 +14,14 @@ module Rails
         def self.included(base)
           base.module_eval do
             class_inheritable_accessor :excel_strategy, :instance_writer => false
+            def excel_strategy
+              @excel_strategy ||= self.class.excel_strategy
+            end
+
+            def excel_strategy=(strategy)
+              @excel_strategy = strategy
+            end
+
             self.excel_strategy = ::Rails::Excel.strategy
           end
 

data/lib/rails-excel/version.rb

@@ -1,5 +1,5 @@
 module Rails
   module Excel
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rails-excel
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Ramihajamalala Hery
@@ -15,12 +15,13 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-22 00:00:00 +02:00
+date: 2011-08-23 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rake
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
@@ -31,12 +32,12 @@ dependencies:
         - 8
         - 7
         version: 0.8.7
-  prerelease: false
-  requirement: *id001
   type: :development
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: rspec
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -47,12 +48,12 @@ dependencies:
         - 3
         - 0
         version: 2.3.0
-  prerelease: false
-  requirement: *id002
   type: :development
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: rcov
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -63,12 +64,12 @@ dependencies:
         - 9
         - 9
         version: 0.9.9
-  prerelease: false
-  requirement: *id003
   type: :development
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: actionpack
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -79,12 +80,12 @@ dependencies:
         - 3
         - 0
         version: 2.3.0
-  prerelease: false
-  requirement: *id004
   type: :development
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: writeexcel
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -95,12 +96,12 @@ dependencies:
         - 6
         - 8
         version: 0.6.8
-  prerelease: false
-  requirement: *id005
   type: :runtime
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: spreadsheet
-  version_requirements: &id006 !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -112,9 +113,8 @@ dependencies:
         - 3
         - 1
         version: 0.6.3.1
-  prerelease: false
-  requirement: *id006
   type: :runtime
+  version_requirements: *id006
 description: "Use different strategies to write excel : available are :spreadsheet and :writeexcel\n    This implements rxls template in your rails view\n  "
 email: 
 - hery@weborama.com
@@ -127,8 +127,11 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - .rvmrc
+- Changelog
 - Gemfile
+- README.md
 - Rakefile
+- TODO.md
 - lib/rails-excel.rb
 - lib/rails-excel/delegation.rb
 - lib/rails-excel/strategies.rb