├── test ├── dummy │ ├── log │ │ └── .gitkeep │ ├── app │ │ ├── mailers │ │ │ └── .gitkeep │ │ ├── models │ │ │ └── .gitkeep │ │ ├── helpers │ │ │ └── application_helper.rb │ │ ├── views │ │ │ ├── koala │ │ │ │ ├── index.html.erb │ │ │ │ └── index.xls.rxls │ │ │ └── layouts │ │ │ │ └── application.html.erb │ │ ├── assets │ │ │ ├── config │ │ │ │ └── manifest.js │ │ │ ├── stylesheets │ │ │ │ └── application.css │ │ │ └── javascripts │ │ │ │ └── application.js │ │ └── controllers │ │ │ ├── application_controller.rb │ │ │ └── koala_controller.rb │ ├── config │ │ ├── storage.yml │ │ ├── environment.rb │ │ ├── routes.rb │ │ ├── locales │ │ │ └── en.yml │ │ ├── boot.rb │ │ ├── initializers │ │ │ ├── mime_types.rb │ │ │ ├── backtrace_silencers.rb │ │ │ ├── session_store.rb │ │ │ ├── secret_token.rb │ │ │ ├── wrap_parameters.rb │ │ │ └── inflections.rb │ │ ├── database.yml │ │ ├── environments │ │ │ ├── development.rb │ │ │ ├── test.rb │ │ │ └── production.rb │ │ └── application.rb │ ├── lib │ │ └── assets │ │ │ └── .gitkeep │ ├── public │ │ ├── favicon.ico │ │ ├── 500.html │ │ ├── 422.html │ │ └── 404.html │ ├── .gitignore │ ├── config.ru │ ├── Rakefile │ ├── script │ │ └── rails │ └── README.rdoc ├── spreadsheet_on_rails_test.rb ├── test_helper.rb └── integration │ └── navigation_test.rb ├── .tool-versions ├── lib ├── spreadsheet_on_rails │ └── version.rb ├── tasks │ └── spreadsheet_on_rails_tasks.rake └── spreadsheet_on_rails.rb ├── gemfiles ├── rails_6.1.gemfile └── rails_6.1.gemfile.lock ├── .gitignore ├── Appraisals ├── .travis.yml ├── Gemfile ├── Rakefile ├── MIT-LICENSE ├── spreadsheet_on_rails.gemspec └── README.rdoc /test/dummy/log/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /.tool-versions: -------------------------------------------------------------------------------- 1 | ruby 3.2.2 2 | -------------------------------------------------------------------------------- /test/dummy/app/mailers/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /test/dummy/app/models/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /test/dummy/config/storage.yml: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /test/dummy/lib/assets/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /test/dummy/public/favicon.ico: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /test/dummy/app/helpers/application_helper.rb: -------------------------------------------------------------------------------- 1 | module ApplicationHelper 2 | end 3 | -------------------------------------------------------------------------------- /lib/spreadsheet_on_rails/version.rb: -------------------------------------------------------------------------------- 1 | module SpreadsheetOnRails 2 | VERSION = "1.0.1" 3 | end 4 | -------------------------------------------------------------------------------- /test/dummy/.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store 2 | log 3 | tmp 4 | db/*.sqlite3 5 | public/stylesheets/compiled/* 6 | -------------------------------------------------------------------------------- /test/dummy/app/views/koala/index.html.erb: -------------------------------------------------------------------------------- 1 |

Download XLS below

2 |

<%= link_to "XLS", koala_path("xls") %>

3 | -------------------------------------------------------------------------------- /test/dummy/app/assets/config/manifest.js: -------------------------------------------------------------------------------- 1 | //= link application.js 2 | //= link application.css 3 | //= link_directory ../stylesheets .css 4 | -------------------------------------------------------------------------------- /test/dummy/app/controllers/application_controller.rb: -------------------------------------------------------------------------------- 1 | class ApplicationController < ActionController::Base 2 | protect_from_forgery 3 | end 4 | -------------------------------------------------------------------------------- /lib/tasks/spreadsheet_on_rails_tasks.rake: -------------------------------------------------------------------------------- 1 | # desc "Explaining what the task does" 2 | # task :spreadsheet_on_rails do 3 | # # Task goes here 4 | # end 5 | -------------------------------------------------------------------------------- /test/dummy/app/views/koala/index.xls.rxls: -------------------------------------------------------------------------------- 1 | sheet = workbook.create_worksheet 2 | sheet.name = "Koalas" 3 | sheet.row(0).push "This is a row" 4 | sheet.row(1).push "This is a second row" 5 | -------------------------------------------------------------------------------- /test/dummy/config.ru: -------------------------------------------------------------------------------- 1 | # This file is used by Rack-based servers to start the application. 2 | 3 | require ::File.expand_path('../config/environment', __FILE__) 4 | run Dummy::Application 5 | -------------------------------------------------------------------------------- /gemfiles/rails_6.1.gemfile: -------------------------------------------------------------------------------- 1 | # This file was generated by Appraisal 2 | 3 | source "http://rubygems.org" 4 | 5 | gem "jquery-rails" 6 | gem "activemodel", "~> 6.1.0" 7 | 8 | gemspec path: "../" 9 | -------------------------------------------------------------------------------- /test/dummy/config/environment.rb: -------------------------------------------------------------------------------- 1 | # Load the rails application 2 | require File.expand_path('../application', __FILE__) 3 | 4 | # Initialize the rails application 5 | Dummy::Application.initialize! 6 | -------------------------------------------------------------------------------- /test/dummy/config/routes.rb: -------------------------------------------------------------------------------- 1 | Dummy::Application.routes.draw do 2 | get "/koala(.:format)", :to => "koala#index", :as => :koala 3 | get "/another(.:format)", :to => "koala#another", :as => :another 4 | end 5 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # rcov generated 2 | coverage 3 | 4 | # rdoc generated 5 | rdoc 6 | 7 | # yard generated 8 | doc 9 | .yardoc 10 | 11 | # bundler 12 | .bundle 13 | 14 | # jeweler generated 15 | pkg 16 | .rvmrc 17 | Gemfile.lock 18 | -------------------------------------------------------------------------------- /test/dummy/config/locales/en.yml: -------------------------------------------------------------------------------- 1 | # Sample localization file for English. Add more files in this directory for other locales. 2 | # See https://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points. 3 | 4 | en: 5 | hello: "Hello world" 6 | -------------------------------------------------------------------------------- /test/dummy/config/boot.rb: -------------------------------------------------------------------------------- 1 | require 'rubygems' 2 | gemfile = File.expand_path('../../../../Gemfile', __FILE__) 3 | 4 | if File.exist?(gemfile) 5 | ENV['BUNDLE_GEMFILE'] = gemfile 6 | require 'bundler' 7 | Bundler.setup 8 | end 9 | 10 | $:.unshift File.expand_path('../../../../lib', __FILE__) -------------------------------------------------------------------------------- /test/dummy/Rakefile: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env rake 2 | # Add your own tasks in files placed in lib/tasks ending in .rake, 3 | # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake. 4 | 5 | require File.expand_path('../config/application', __FILE__) 6 | 7 | Dummy::Application.load_tasks 8 | -------------------------------------------------------------------------------- /test/dummy/config/initializers/mime_types.rb: -------------------------------------------------------------------------------- 1 | # Be sure to restart your server when you modify this file. 2 | 3 | # Add new mime types for use in respond_to blocks: 4 | # Mime::Type.register "text/richtext", :rtf 5 | # Mime::Type.register_alias "text/html", :iphone 6 | Mime::Type.register "application/xls", :xls 7 | -------------------------------------------------------------------------------- /test/dummy/script/rails: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env ruby 2 | # This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application. 3 | 4 | APP_PATH = File.expand_path('../../config/application', __FILE__) 5 | require File.expand_path('../../config/boot', __FILE__) 6 | require 'rails/commands' 7 | -------------------------------------------------------------------------------- /test/dummy/app/views/layouts/application.html.erb: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | Dummy 5 | <%= stylesheet_link_tag "application", :media => "all" %> 6 | <%= javascript_include_tag "application" %> 7 | <%= csrf_meta_tags %> 8 | 9 | 10 | 11 | <%= yield %> 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /test/spreadsheet_on_rails_test.rb: -------------------------------------------------------------------------------- 1 | require 'test_helper' 2 | 3 | 4 | class SpreadsheetOnRailsTest < ActiveSupport::TestCase 5 | test "xls mime type" do 6 | assert_equal "application/xls", Mime[:xls].to_s 7 | end 8 | 9 | test "xls sym should be xls" do 10 | assert_equal :xls, Mime[:xls].to_sym 11 | end 12 | 13 | end 14 | -------------------------------------------------------------------------------- /test/dummy/app/controllers/koala_controller.rb: -------------------------------------------------------------------------------- 1 | class KoalaController < ApplicationController 2 | def index 3 | respond_to do |format| 4 | format.html 5 | format.xls { render :xls => "koalatastic"} 6 | end 7 | end 8 | 9 | def another 10 | render :xls => "contents", :template => "koala/index" 11 | end 12 | end 13 | -------------------------------------------------------------------------------- /Appraisals: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | # appraise 'rails-4.2' do 4 | # gem 'activemodel', '~> 4.2.0' 5 | # end 6 | 7 | # appraise 'rails-5.2' do 8 | # gem 'activemodel', '~> 5.2.0' 9 | # end 10 | 11 | appraise 'rails-6.1' do 12 | gem 'activemodel', '~> 6.1.0' 13 | end 14 | 15 | # appraise 'rails_edge' do 16 | # gem 'activemodel', github: 'rails/rails' 17 | # end 18 | -------------------------------------------------------------------------------- /test/dummy/config/initializers/backtrace_silencers.rb: -------------------------------------------------------------------------------- 1 | # Be sure to restart your server when you modify this file. 2 | 3 | # You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces. 4 | # Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ } 5 | 6 | # You can also remove all the silencers if you're trying to debug a problem that might stem from framework code. 7 | # Rails.backtrace_cleaner.remove_silencers! 8 | -------------------------------------------------------------------------------- /test/dummy/config/initializers/session_store.rb: -------------------------------------------------------------------------------- 1 | # Be sure to restart your server when you modify this file. 2 | 3 | Dummy::Application.config.session_store :cookie_store, key: '_dummy_session' 4 | 5 | # Use the database for sessions instead of the cookie-based default, 6 | # which shouldn't be used to store highly confidential information 7 | # (create the session table with "rails generate session_migration") 8 | # Dummy::Application.config.session_store :active_record_store 9 | -------------------------------------------------------------------------------- /test/dummy/config/initializers/secret_token.rb: -------------------------------------------------------------------------------- 1 | # Be sure to restart your server when you modify this file. 2 | 3 | # Your secret key for verifying the integrity of signed cookies. 4 | # If you change this key, all old signed cookies will become invalid! 5 | # Make sure the secret is at least 30 characters and all random, 6 | # no regular words or you'll be exposed to dictionary attacks. 7 | Dummy::Application.config.secret_token = '22e97e271d9b6709bca4547572ee1bbb7b75ec514616a065f1ee64fabf10dc74063c7e6bd9c786685f217e61011e26adb63d53569c5f57afcc7f484950ac5cfe' 8 | -------------------------------------------------------------------------------- /test/dummy/config/initializers/wrap_parameters.rb: -------------------------------------------------------------------------------- 1 | # Be sure to restart your server when you modify this file. 2 | # 3 | # This file contains settings for ActionController::ParamsWrapper which 4 | # is enabled by default. 5 | 6 | # Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array. 7 | ActiveSupport.on_load(:action_controller) do 8 | wrap_parameters format: [:json] 9 | end 10 | 11 | # Disable root element in JSON by default. 12 | ActiveSupport.on_load(:active_record) do 13 | self.include_root_in_json = false 14 | end 15 | -------------------------------------------------------------------------------- /test/dummy/config/initializers/inflections.rb: -------------------------------------------------------------------------------- 1 | # Be sure to restart your server when you modify this file. 2 | 3 | # Add new inflection rules using the following format 4 | # (all these examples are active by default): 5 | # ActiveSupport::Inflector.inflections do |inflect| 6 | # inflect.plural /^(ox)$/i, '\1en' 7 | # inflect.singular /^(ox)en/i, '\1' 8 | # inflect.irregular 'person', 'people' 9 | # inflect.uncountable %w( fish sheep ) 10 | # end 11 | # 12 | # These inflection rules are supported but not enabled by default: 13 | # ActiveSupport::Inflector.inflections do |inflect| 14 | # inflect.acronym 'RESTful' 15 | # end 16 | -------------------------------------------------------------------------------- /test/dummy/app/assets/stylesheets/application.css: -------------------------------------------------------------------------------- 1 | /* 2 | * This is a manifest file that'll be compiled into application.css, which will include all the files 3 | * listed below. 4 | * 5 | * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets, 6 | * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path. 7 | * 8 | * You're free to add application-wide styles to this file and they'll appear at the top of the 9 | * compiled file, but it's generally better to create a new file per style scope. 10 | * 11 | *= require_self 12 | *= require_tree . 13 | */ 14 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | dist: xenial 2 | language: ruby 3 | sudo: false 4 | 5 | cache: bundler 6 | 7 | bundler_args: --jobs 3 --retry 3 8 | 9 | before_install: 10 | - "travis_retry gem update --system" 11 | - "travis_retry gem install bundler" 12 | 13 | script: "bundle exec rake" 14 | 15 | rvm: 16 | - 2.6.5 17 | - 2.7.2 18 | - 3.0.0 19 | - ruby-head 20 | - truffleruby 21 | 22 | gemfile: 23 | # - gemfiles/rails_5.2.gemfile 24 | - gemfiles/rails_6.1.gemfile 25 | # - gemfiles/rails_edge.gemfile 26 | 27 | matrix: 28 | fast_finish: true 29 | allow_failures: 30 | - rvm: ruby-head 31 | exclude: 32 | # - rvm: 3.0.0 33 | # gemfile: gemfiles/rails_edge.gemfile 34 | -------------------------------------------------------------------------------- /test/dummy/config/database.yml: -------------------------------------------------------------------------------- 1 | # SQLite version 3.x 2 | # gem install sqlite3 3 | # 4 | # Ensure the SQLite 3 gem is defined in your Gemfile 5 | # gem 'sqlite3' 6 | development: 7 | adapter: sqlite3 8 | database: db/development.sqlite3 9 | pool: 5 10 | timeout: 5000 11 | 12 | # Warning: The database defined as "test" will be erased and 13 | # re-generated from your development database when you run "rake". 14 | # Do not set this db to the same as development or production. 15 | test: 16 | adapter: sqlite3 17 | database: ":memory:" 18 | timeout: 500 19 | 20 | production: 21 | adapter: sqlite3 22 | database: db/production.sqlite3 23 | pool: 5 24 | timeout: 5000 25 | -------------------------------------------------------------------------------- /Gemfile: -------------------------------------------------------------------------------- 1 | source "http://rubygems.org" 2 | 3 | # Declare your gem's dependencies in spreadsheet_on_rails.gemspec. 4 | # Bundler will treat runtime dependencies like base dependencies, and 5 | # development dependencies will be added by default to the :development group. 6 | gemspec 7 | 8 | # jquery-rails is used by the dummy application 9 | gem "jquery-rails" 10 | 11 | # Declare any dependencies that are still in development here instead of in 12 | # your gemspec. These might include edge Rails or gems from your path or 13 | # Git. Remember to move these dependencies to your gemspec before releasing 14 | # your gem to rubygems.org. 15 | 16 | # To use debugger 17 | # gem 'ruby-debug19', :require => 'ruby-debug' 18 | -------------------------------------------------------------------------------- /test/dummy/app/assets/javascripts/application.js: -------------------------------------------------------------------------------- 1 | // This is a manifest file that'll be compiled into application.js, which will include all the files 2 | // listed below. 3 | // 4 | // Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts, 5 | // or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path. 6 | // 7 | // It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the 8 | // the compiled file. 9 | // 10 | // WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD 11 | // GO AFTER THE REQUIRES BELOW. 12 | // 13 | //= require jquery 14 | //= require jquery_ujs 15 | //= require_tree . 16 | -------------------------------------------------------------------------------- /test/dummy/public/500.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | We're sorry, but something went wrong (500) 5 | 17 | 18 | 19 | 20 | 21 |
22 |

We're sorry, but something went wrong.

23 |
24 | 25 | 26 | -------------------------------------------------------------------------------- /test/dummy/public/422.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | The change you wanted was rejected (422) 5 | 17 | 18 | 19 | 20 | 21 |
22 |

The change you wanted was rejected.

23 |

Maybe you tried to change something you didn't have access to.

24 |
25 | 26 | 27 | -------------------------------------------------------------------------------- /test/dummy/public/404.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | The page you were looking for doesn't exist (404) 5 | 17 | 18 | 19 | 20 | 21 |
22 |

The page you were looking for doesn't exist.

23 |

You may have mistyped the address or the page may have moved.

24 |
25 | 26 | 27 | -------------------------------------------------------------------------------- /test/test_helper.rb: -------------------------------------------------------------------------------- 1 | # Configure Rails Environment 2 | ENV["RAILS_ENV"] = "test" 3 | 4 | require File.expand_path("../dummy/config/environment.rb", __FILE__) 5 | require "rails/test_help" 6 | require 'capybara/rails' 7 | require "shoulda" 8 | 9 | Rails.backtrace_cleaner.remove_silencers! 10 | 11 | # Load support files 12 | Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f } 13 | 14 | class ActionDispatch::IntegrationTest 15 | # Make the Capybara DSL available in all integration tests 16 | include Capybara::DSL 17 | 18 | # # Stop ActiveRecord from wrapping tests in transactions 19 | # self.use_transactional_fixtures = false 20 | 21 | teardown do 22 | Capybara.reset_sessions! # Forget the (simulated) browser state 23 | Capybara.use_default_driver # Revert Capybara.current_driver to Capybara.default_driver 24 | end 25 | end 26 | -------------------------------------------------------------------------------- /Rakefile: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env rake 2 | begin 3 | require 'bundler/setup' 4 | rescue LoadError 5 | puts 'You must `gem install bundler` and `bundle install` to run rake tasks' 6 | end 7 | begin 8 | require 'rdoc/task' 9 | rescue LoadError 10 | require 'rdoc/rdoc' 11 | require 'rake/rdoctask' 12 | RDoc::Task = Rake::RDocTask 13 | end 14 | 15 | RDoc::Task.new(:rdoc) do |rdoc| 16 | rdoc.rdoc_dir = 'rdoc' 17 | rdoc.title = 'SpreadsheetOnRails' 18 | rdoc.options << '--line-numbers' 19 | rdoc.rdoc_files.include('README.rdoc') 20 | rdoc.rdoc_files.include('lib/**/*.rb') 21 | end 22 | 23 | 24 | 25 | 26 | Bundler::GemHelper.install_tasks 27 | 28 | require 'rake/testtask' 29 | 30 | Rake::TestTask.new(:test) do |t| 31 | t.libs << 'lib' 32 | t.libs << 'test' 33 | t.pattern = 'test/**/*_test.rb' 34 | t.verbose = false 35 | end 36 | 37 | 38 | task :default => :test 39 | -------------------------------------------------------------------------------- /MIT-LICENSE: -------------------------------------------------------------------------------- 1 | Copyright 2012 YOURNAME 2 | 3 | Permission is hereby granted, free of charge, to any person obtaining 4 | a copy of this software and associated documentation files (the 5 | "Software"), to deal in the Software without restriction, including 6 | without limitation the rights to use, copy, modify, merge, publish, 7 | distribute, sublicense, and/or sell copies of the Software, and to 8 | permit persons to whom the Software is furnished to do so, subject to 9 | the following conditions: 10 | 11 | The above copyright notice and this permission notice shall be 12 | included in all copies or substantial portions of the Software. 13 | 14 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 15 | EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 16 | MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 17 | NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE 18 | LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION 19 | OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION 20 | WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 21 | -------------------------------------------------------------------------------- /lib/spreadsheet_on_rails.rb: -------------------------------------------------------------------------------- 1 | module SpreadsheetOnRails 2 | def self.render_xls_string(spreadsheet) 3 | <(obj, template) { 17 | SpreadsheetOnRails.render_xls_string(obj.source) 18 | } 19 | 20 | # # Why doesn't the aboce template handler catch this one as well? 21 | # # Added for backwards compatibility. 22 | ActionView::Template.register_template_handler :"xls.rxls", ->(obj, template) { 23 | SpreadsheetOnRails.render_xls_string(obj.source) 24 | } 25 | 26 | # Adds support for `format.xls` 27 | require "action_controller" 28 | Mime::Type.register "application/xls", :xls 29 | 30 | ActionController::Renderers.add :xls do |filename, options| 31 | send_data render_to_string(options), 32 | type: "application/xls", 33 | disposition: "attachment; filename=#{filename}.xls" 34 | end 35 | -------------------------------------------------------------------------------- /spreadsheet_on_rails.gemspec: -------------------------------------------------------------------------------- 1 | $:.push File.expand_path("../lib", __FILE__) 2 | 3 | # Maintain your gem's version: 4 | require "spreadsheet_on_rails/version" 5 | 6 | # Describe your gem and declare its dependencies: 7 | Gem::Specification.new do |s| 8 | s.name = "spreadsheet_on_rails" 9 | s.version = SpreadsheetOnRails::VERSION 10 | s.authors = ["Koen Van der Auwera", "Piet Jaspers"] 11 | s.email = ["koen@10to1.be", "piet@10to1.be"] 12 | s.homepage = "https://github.com/10to1/spreadsheet_on_rails" 13 | s.summary = "Support for XLS based views" 14 | s.description = "A gem to generate xls documents by using rxls templates." 15 | 16 | s.files = Dir["{app,config,db,lib}/**/*"] + ["MIT-LICENSE", "Rakefile", "README.rdoc"] 17 | s.test_files = Dir["test/**/*"] 18 | 19 | s.add_dependency "rails", "~> 8.0" 20 | # s.add_dependency "spreadsheet", "~> 1.0.4" 21 | s.add_dependency "spreadsheet" 22 | 23 | s.add_development_dependency 'appraisal' 24 | s.add_development_dependency "sqlite3" 25 | s.add_development_dependency "capybara" 26 | s.add_development_dependency "shoulda" 27 | s.add_development_dependency "pry-byebug" 28 | end 29 | -------------------------------------------------------------------------------- /test/integration/navigation_test.rb: -------------------------------------------------------------------------------- 1 | require 'test_helper' 2 | class NavigationTest < ActionDispatch::IntegrationTest 3 | context "sending an xls file" do 4 | setup do 5 | visit koala_path 6 | click_link 'XLS' 7 | end 8 | 9 | should "set binary header" do 10 | assert_equal 'binary', headers['Content-Transfer-Encoding'] 11 | end 12 | 13 | should "set correct filename" do 14 | assert_equal 'attachment; filename=koalatastic.xls', headers['Content-Disposition'] 15 | end 16 | 17 | should "set correct content type" do 18 | assert_equal 'application/xls', headers['Content-Type'] 19 | end 20 | end 21 | 22 | context 'xls renderer uses the specified template' do 23 | setup do 24 | visit '/another.pdf' 25 | end 26 | 27 | should "set binary header" do 28 | assert_equal 'binary', headers['Content-Transfer-Encoding'] 29 | end 30 | 31 | should "set correct filename" do 32 | assert_equal 'attachment; filename=contents.xls', headers['Content-Disposition'] 33 | end 34 | 35 | should "set correct content type" do 36 | assert_equal 'application/xls', headers['Content-Type'] 37 | end 38 | end 39 | 40 | protected 41 | 42 | def headers 43 | page.response_headers 44 | end 45 | end 46 | -------------------------------------------------------------------------------- /test/dummy/config/environments/development.rb: -------------------------------------------------------------------------------- 1 | Dummy::Application.configure do 2 | # Settings specified here will take precedence over those in config/application.rb 3 | 4 | # In the development environment your application's code is reloaded on 5 | # every request. This slows down response time but is perfect for development 6 | # since you don't have to restart the web server when you make code changes. 7 | config.cache_classes = false 8 | 9 | # Show full error reports and disable caching 10 | config.consider_all_requests_local = true 11 | config.action_controller.perform_caching = false 12 | 13 | # Don't care if the mailer can't send 14 | config.action_mailer.raise_delivery_errors = false 15 | 16 | # Print deprecation notices to the Rails logger 17 | config.active_support.deprecation = :log 18 | 19 | # Only use best-standards-support built into browsers 20 | config.action_dispatch.best_standards_support = :builtin 21 | 22 | # Log the query plan for queries taking more than this (works 23 | # with SQLite, MySQL, and PostgreSQL) 24 | config.active_record.auto_explain_threshold_in_seconds = 0.5 25 | 26 | # Do not compress assets 27 | config.assets.compress = false 28 | 29 | # Expands the lines which load the assets 30 | config.assets.debug = true 31 | end 32 | -------------------------------------------------------------------------------- /test/dummy/config/environments/test.rb: -------------------------------------------------------------------------------- 1 | Dummy::Application.configure do 2 | # Settings specified here will take precedence over those in config/application.rb 3 | 4 | # The test environment is used exclusively to run your application's 5 | # test suite. You never need to work with it otherwise. Remember that 6 | # your test database is "scratch space" for the test suite and is wiped 7 | # and recreated between test runs. Don't rely on the data there! 8 | config.cache_classes = true 9 | 10 | # Configure static asset server for tests with Cache-Control for performance 11 | config.serve_static_assets = true 12 | config.static_cache_control = "public, max-age=3600" 13 | 14 | # Show full error reports and disable caching 15 | config.consider_all_requests_local = true 16 | config.action_controller.perform_caching = false 17 | 18 | # Raise exceptions instead of rendering exception templates 19 | config.action_dispatch.show_exceptions = false 20 | 21 | # Disable request forgery protection in test environment 22 | config.action_controller.allow_forgery_protection = false 23 | 24 | # Tell Action Mailer not to deliver emails to the real world. 25 | # The :test delivery method accumulates sent emails in the 26 | # ActionMailer::Base.deliveries array. 27 | config.action_mailer.delivery_method = :test 28 | 29 | # Print deprecation notices to the stderr 30 | config.active_support.deprecation = :stderr 31 | end 32 | -------------------------------------------------------------------------------- /README.rdoc: -------------------------------------------------------------------------------- 1 | = SpreadsheetOnRails 2 | 3 | A gem to generate xls documents by using rxls templates. 4 | 5 | Based on {Defv}[http://github.com/DefV]'s {railsxls plugin}[http://github.com/DefV/railsxls] without the Java part. 6 | 7 | == Installation 8 | 9 | In Rails 3, add this to your Gemfile and run the +bundle+ command. 10 | 11 | gem "spreadsheet_on_rails" 12 | 13 | == Getting Started 14 | 15 | Add support for the new format in your controller: 16 | 17 | class HomeController < ApplicationController 18 | 19 | def index 20 | respond_to do |format| 21 | format.html 22 | format.xls { render :xls => ""} 23 | end 24 | end 25 | end 26 | 27 | Create an xls view +app/views/home/index.rxls+: 28 | 29 | sheet = workbook.create_worksheet 30 | sheet.name = "What's in a name" 31 | 32 | sheet.row(0).concat %w{Name Country Acknowlegement} 33 | sheet[1,0] = 'Japan' 34 | row = sheet.row(1) 35 | row.push 'Creator of Ruby' 36 | row.unshift 'Yukihiro Matsumoto' 37 | sheet.row(2).replace [ 'Daniel J. Berger', 'U.S.A.', 38 | 'Author of original code for Spreadsheet::Excel' ] 39 | sheet.row(3).push 'Charles Lowe', 'Author of the ruby-ole Library' 40 | sheet.row(3).insert 1, 'Unknown' 41 | sheet.update_row 4, 'Hannes Wyss', 'Switzerland', 'Author' 42 | 43 | The view basically allow you to write directly with the +spreadsheet+ gem. 44 | 45 | {Build Status}[http://travis-ci.org/10to1/spreadsheet_on_rails] 46 | 47 | Copyright (c) 2012 10to1, released under the MIT license 48 | -------------------------------------------------------------------------------- /test/dummy/config/environments/production.rb: -------------------------------------------------------------------------------- 1 | Dummy::Application.configure do 2 | # Settings specified here will take precedence over those in config/application.rb 3 | 4 | # Code is not reloaded between requests 5 | config.cache_classes = true 6 | 7 | # Full error reports are disabled and caching is turned on 8 | config.consider_all_requests_local = false 9 | config.action_controller.perform_caching = true 10 | 11 | # Disable Rails's static asset server (Apache or nginx will already do this) 12 | config.serve_static_assets = false 13 | 14 | # Compress JavaScripts and CSS 15 | config.assets.compress = true 16 | 17 | # Don't fallback to assets pipeline if a precompiled asset is missed 18 | config.assets.compile = false 19 | 20 | # Generate digests for assets URLs 21 | config.assets.digest = true 22 | 23 | # Defaults to Rails.root.join("public/assets") 24 | # config.assets.manifest = YOUR_PATH 25 | 26 | # Specifies the header that your server uses for sending files 27 | # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache 28 | # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx 29 | 30 | # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies. 31 | # config.force_ssl = true 32 | 33 | # See everything in the log (default is :info) 34 | # config.log_level = :debug 35 | 36 | # Prepend all log lines with the following tags 37 | # config.log_tags = [ :subdomain, :uuid ] 38 | 39 | # Use a different logger for distributed setups 40 | # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new) 41 | 42 | # Use a different cache store in production 43 | # config.cache_store = :mem_cache_store 44 | 45 | # Enable serving of images, stylesheets, and JavaScripts from an asset server 46 | # config.action_controller.asset_host = "http://assets.example.com" 47 | 48 | # Precompile additional assets (application.js, application.css, and all non-JS/CSS are already added) 49 | # config.assets.precompile += %w( search.js ) 50 | 51 | # Disable delivery errors, bad email addresses will be ignored 52 | # config.action_mailer.raise_delivery_errors = false 53 | 54 | # Enable threaded mode 55 | # config.threadsafe! 56 | 57 | # Enable locale fallbacks for I18n (makes lookups for any locale fall back to 58 | # the I18n.default_locale when a translation can not be found) 59 | config.i18n.fallbacks = true 60 | 61 | # Send deprecation notices to registered listeners 62 | config.active_support.deprecation = :notify 63 | end 64 | -------------------------------------------------------------------------------- /test/dummy/config/application.rb: -------------------------------------------------------------------------------- 1 | require File.expand_path('../boot', __FILE__) 2 | 3 | require 'rails/all' 4 | 5 | Bundler.require 6 | require "spreadsheet_on_rails" 7 | 8 | module Dummy 9 | class Application < Rails::Application 10 | # Settings in config/environments/* take precedence over those specified here. 11 | # Application configuration should go into files in config/initializers 12 | # -- all .rb files in that directory are automatically loaded. 13 | 14 | # Custom directories with classes and modules you want to be autoloadable. 15 | # config.autoload_paths += %W(#{config.root}/extras) 16 | 17 | # Only load the plugins named here, in the order given (default is alphabetical). 18 | # :all can be used as a placeholder for all plugins not explicitly named. 19 | # config.plugins = [ :exception_notification, :ssl_requirement, :all ] 20 | 21 | # Activate observers that should always be running. 22 | # config.active_record.observers = :cacher, :garbage_collector, :forum_observer 23 | 24 | # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone. 25 | # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC. 26 | # config.time_zone = 'Central Time (US & Canada)' 27 | 28 | # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded. 29 | # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s] 30 | # config.i18n.default_locale = :de 31 | 32 | # Configure the default encoding used in templates for Ruby 1.9. 33 | config.encoding = "utf-8" 34 | 35 | # Configure sensitive parameters which will be filtered from the log file. 36 | config.filter_parameters += [:password] 37 | 38 | # Use SQL instead of Active Record's schema dumper when creating the database. 39 | # This is necessary if your schema can't be completely dumped by the schema dumper, 40 | # like if you have constraints or database-specific column types 41 | # config.active_record.schema_format = :sql 42 | 43 | # Enforce whitelist mode for mass assignment. 44 | # This will create an empty whitelist of attributes available for mass-assignment for all models 45 | # in your app. As such, your models will need to explicitly whitelist or blacklist accessible 46 | # parameters by using an attr_accessible or attr_protected declaration. 47 | # config.active_record.whitelist_attributes = true 48 | 49 | # Enable the asset pipeline 50 | config.assets.enabled = true 51 | 52 | # Version of your assets, change this if you want to expire all your assets 53 | config.assets.version = '1.0' 54 | end 55 | end 56 | 57 | -------------------------------------------------------------------------------- /gemfiles/rails_6.1.gemfile.lock: -------------------------------------------------------------------------------- 1 | PATH 2 | remote: .. 3 | specs: 4 | spreadsheet_on_rails (1.0.0) 5 | rails (~> 6.1) 6 | spreadsheet 7 | 8 | GEM 9 | remote: http://rubygems.org/ 10 | specs: 11 | actioncable (6.1.7.4) 12 | actionpack (= 6.1.7.4) 13 | activesupport (= 6.1.7.4) 14 | nio4r (~> 2.0) 15 | websocket-driver (>= 0.6.1) 16 | actionmailbox (6.1.7.4) 17 | actionpack (= 6.1.7.4) 18 | activejob (= 6.1.7.4) 19 | activerecord (= 6.1.7.4) 20 | activestorage (= 6.1.7.4) 21 | activesupport (= 6.1.7.4) 22 | mail (>= 2.7.1) 23 | actionmailer (6.1.7.4) 24 | actionpack (= 6.1.7.4) 25 | actionview (= 6.1.7.4) 26 | activejob (= 6.1.7.4) 27 | activesupport (= 6.1.7.4) 28 | mail (~> 2.5, >= 2.5.4) 29 | rails-dom-testing (~> 2.0) 30 | actionpack (6.1.7.4) 31 | actionview (= 6.1.7.4) 32 | activesupport (= 6.1.7.4) 33 | rack (~> 2.0, >= 2.0.9) 34 | rack-test (>= 0.6.3) 35 | rails-dom-testing (~> 2.0) 36 | rails-html-sanitizer (~> 1.0, >= 1.2.0) 37 | actiontext (6.1.7.4) 38 | actionpack (= 6.1.7.4) 39 | activerecord (= 6.1.7.4) 40 | activestorage (= 6.1.7.4) 41 | activesupport (= 6.1.7.4) 42 | nokogiri (>= 1.8.5) 43 | actionview (6.1.7.4) 44 | activesupport (= 6.1.7.4) 45 | builder (~> 3.1) 46 | erubi (~> 1.4) 47 | rails-dom-testing (~> 2.0) 48 | rails-html-sanitizer (~> 1.1, >= 1.2.0) 49 | activejob (6.1.7.4) 50 | activesupport (= 6.1.7.4) 51 | globalid (>= 0.3.6) 52 | activemodel (6.1.7.4) 53 | activesupport (= 6.1.7.4) 54 | activerecord (6.1.7.4) 55 | activemodel (= 6.1.7.4) 56 | activesupport (= 6.1.7.4) 57 | activestorage (6.1.7.4) 58 | actionpack (= 6.1.7.4) 59 | activejob (= 6.1.7.4) 60 | activerecord (= 6.1.7.4) 61 | activesupport (= 6.1.7.4) 62 | marcel (~> 1.0) 63 | mini_mime (>= 1.1.0) 64 | activesupport (6.1.7.4) 65 | concurrent-ruby (~> 1.0, >= 1.0.2) 66 | i18n (>= 1.6, < 2) 67 | minitest (>= 5.1) 68 | tzinfo (~> 2.0) 69 | zeitwerk (~> 2.3) 70 | addressable (2.8.4) 71 | public_suffix (>= 2.0.2, < 6.0) 72 | appraisal (2.4.1) 73 | bundler 74 | rake 75 | thor (>= 0.14.0) 76 | builder (3.2.4) 77 | byebug (11.1.3) 78 | capybara (3.39.2) 79 | addressable 80 | matrix 81 | mini_mime (>= 0.1.3) 82 | nokogiri (~> 1.8) 83 | rack (>= 1.6.0) 84 | rack-test (>= 0.6.3) 85 | regexp_parser (>= 1.5, < 3.0) 86 | xpath (~> 3.2) 87 | coderay (1.1.3) 88 | concurrent-ruby (1.2.2) 89 | crass (1.0.6) 90 | date (3.3.3) 91 | erubi (1.12.0) 92 | globalid (1.1.0) 93 | activesupport (>= 5.0) 94 | i18n (1.14.1) 95 | concurrent-ruby (~> 1.0) 96 | jquery-rails (4.6.0) 97 | rails-dom-testing (>= 1, < 3) 98 | railties (>= 4.2.0) 99 | thor (>= 0.14, < 2.0) 100 | loofah (2.21.3) 101 | crass (~> 1.0.2) 102 | nokogiri (>= 1.12.0) 103 | mail (2.8.1) 104 | mini_mime (>= 0.1.1) 105 | net-imap 106 | net-pop 107 | net-smtp 108 | marcel (1.0.2) 109 | matrix (0.4.2) 110 | method_source (1.0.0) 111 | mini_mime (1.1.2) 112 | minitest (5.18.1) 113 | net-imap (0.3.6) 114 | date 115 | net-protocol 116 | net-pop (0.1.2) 117 | net-protocol 118 | net-protocol (0.2.1) 119 | timeout 120 | net-smtp (0.3.3) 121 | net-protocol 122 | nio4r (2.5.9) 123 | nokogiri (1.15.2-x86_64-darwin) 124 | racc (~> 1.4) 125 | pry (0.14.2) 126 | coderay (~> 1.1) 127 | method_source (~> 1.0) 128 | pry-byebug (3.10.1) 129 | byebug (~> 11.0) 130 | pry (>= 0.13, < 0.15) 131 | public_suffix (5.0.1) 132 | racc (1.7.1) 133 | rack (2.2.7) 134 | rack-test (2.1.0) 135 | rack (>= 1.3) 136 | rails (6.1.7.4) 137 | actioncable (= 6.1.7.4) 138 | actionmailbox (= 6.1.7.4) 139 | actionmailer (= 6.1.7.4) 140 | actionpack (= 6.1.7.4) 141 | actiontext (= 6.1.7.4) 142 | actionview (= 6.1.7.4) 143 | activejob (= 6.1.7.4) 144 | activemodel (= 6.1.7.4) 145 | activerecord (= 6.1.7.4) 146 | activestorage (= 6.1.7.4) 147 | activesupport (= 6.1.7.4) 148 | bundler (>= 1.15.0) 149 | railties (= 6.1.7.4) 150 | sprockets-rails (>= 2.0.0) 151 | rails-dom-testing (2.1.1) 152 | activesupport (>= 5.0.0) 153 | minitest 154 | nokogiri (>= 1.6) 155 | rails-html-sanitizer (1.6.0) 156 | loofah (~> 2.21) 157 | nokogiri (~> 1.14) 158 | railties (6.1.7.4) 159 | actionpack (= 6.1.7.4) 160 | activesupport (= 6.1.7.4) 161 | method_source 162 | rake (>= 12.2) 163 | thor (~> 1.0) 164 | rake (13.0.6) 165 | regexp_parser (2.8.1) 166 | ruby-ole (1.2.12.2) 167 | shoulda (4.0.0) 168 | shoulda-context (~> 2.0) 169 | shoulda-matchers (~> 4.0) 170 | shoulda-context (2.0.0) 171 | shoulda-matchers (4.5.1) 172 | activesupport (>= 4.2.0) 173 | spreadsheet (1.3.0) 174 | ruby-ole 175 | sprockets (4.2.0) 176 | concurrent-ruby (~> 1.0) 177 | rack (>= 2.2.4, < 4) 178 | sprockets-rails (3.4.2) 179 | actionpack (>= 5.2) 180 | activesupport (>= 5.2) 181 | sprockets (>= 3.0.0) 182 | sqlite3 (1.6.3-x86_64-darwin) 183 | thor (1.2.2) 184 | timeout (0.4.0) 185 | tzinfo (2.0.6) 186 | concurrent-ruby (~> 1.0) 187 | websocket-driver (0.7.5) 188 | websocket-extensions (>= 0.1.0) 189 | websocket-extensions (0.1.5) 190 | xpath (3.2.0) 191 | nokogiri (~> 1.8) 192 | zeitwerk (2.6.8) 193 | 194 | PLATFORMS 195 | x86_64-darwin-22 196 | 197 | DEPENDENCIES 198 | activemodel (~> 6.1.0) 199 | appraisal 200 | capybara 201 | jquery-rails 202 | pry-byebug 203 | shoulda 204 | spreadsheet_on_rails! 205 | sqlite3 206 | 207 | BUNDLED WITH 208 | 2.4.15 209 | -------------------------------------------------------------------------------- /test/dummy/README.rdoc: -------------------------------------------------------------------------------- 1 | == Welcome to Rails 2 | 3 | Rails is a web-application framework that includes everything needed to create 4 | database-backed web applications according to the Model-View-Control pattern. 5 | 6 | This pattern splits the view (also called the presentation) into "dumb" 7 | templates that are primarily responsible for inserting pre-built data in between 8 | HTML tags. The model contains the "smart" domain objects (such as Account, 9 | Product, Person, Post) that holds all the business logic and knows how to 10 | persist themselves to a database. The controller handles the incoming requests 11 | (such as Save New Account, Update Product, Show Post) by manipulating the model 12 | and directing data to the view. 13 | 14 | In Rails, the model is handled by what's called an object-relational mapping 15 | layer entitled Active Record. This layer allows you to present the data from 16 | database rows as objects and embellish these data objects with business logic 17 | methods. You can read more about Active Record in 18 | link:files/vendor/rails/activerecord/README.html. 19 | 20 | The controller and view are handled by the Action Pack, which handles both 21 | layers by its two parts: Action View and Action Controller. These two layers 22 | are bundled in a single package due to their heavy interdependence. This is 23 | unlike the relationship between the Active Record and Action Pack that is much 24 | more separate. Each of these packages can be used independently outside of 25 | Rails. You can read more about Action Pack in 26 | link:files/vendor/rails/actionpack/README.html. 27 | 28 | 29 | == Getting Started 30 | 31 | 1. At the command prompt, create a new Rails application: 32 | rails new myapp (where myapp is the application name) 33 | 34 | 2. Change directory to myapp and start the web server: 35 | cd myapp; rails server (run with --help for options) 36 | 37 | 3. Go to http://localhost:3000/ and you'll see: 38 | "Welcome aboard: You're riding Ruby on Rails!" 39 | 40 | 4. Follow the guidelines to start developing your application. You can find 41 | the following resources handy: 42 | 43 | * The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html 44 | * Ruby on Rails Tutorial Book: http://www.railstutorial.org/ 45 | 46 | 47 | == Debugging Rails 48 | 49 | Sometimes your application goes wrong. Fortunately there are a lot of tools that 50 | will help you debug it and get it back on the rails. 51 | 52 | First area to check is the application log files. Have "tail -f" commands 53 | running on the server.log and development.log. Rails will automatically display 54 | debugging and runtime information to these files. Debugging info will also be 55 | shown in the browser on requests from 127.0.0.1. 56 | 57 | You can also log your own messages directly into the log file from your code 58 | using the Ruby logger class from inside your controllers. Example: 59 | 60 | class WeblogController < ActionController::Base 61 | def destroy 62 | @weblog = Weblog.find(params[:id]) 63 | @weblog.destroy 64 | logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!") 65 | end 66 | end 67 | 68 | The result will be a message in your log file along the lines of: 69 | 70 | Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1! 71 | 72 | More information on how to use the logger is at http://www.ruby-doc.org/core/ 73 | 74 | Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are 75 | several books available online as well: 76 | 77 | * Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe) 78 | * Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide) 79 | 80 | These two books will bring you up to speed on the Ruby language and also on 81 | programming in general. 82 | 83 | 84 | == Debugger 85 | 86 | Debugger support is available through the debugger command when you start your 87 | Mongrel or WEBrick server with --debugger. This means that you can break out of 88 | execution at any point in the code, investigate and change the model, and then, 89 | resume execution! You need to install ruby-debug to run the server in debugging 90 | mode. With gems, use sudo gem install ruby-debug. Example: 91 | 92 | class WeblogController < ActionController::Base 93 | def index 94 | @posts = Post.all 95 | debugger 96 | end 97 | end 98 | 99 | So the controller will accept the action, run the first line, then present you 100 | with a IRB prompt in the server window. Here you can do things like: 101 | 102 | >> @posts.inspect 103 | => "[#nil, "body"=>nil, "id"=>"1"}>, 105 | #"Rails", "body"=>"Only ten..", "id"=>"2"}>]" 107 | >> @posts.first.title = "hello from a debugger" 108 | => "hello from a debugger" 109 | 110 | ...and even better, you can examine how your runtime objects actually work: 111 | 112 | >> f = @posts.first 113 | => #nil, "body"=>nil, "id"=>"1"}> 114 | >> f. 115 | Display all 152 possibilities? (y or n) 116 | 117 | Finally, when you're ready to resume execution, you can enter "cont". 118 | 119 | 120 | == Console 121 | 122 | The console is a Ruby shell, which allows you to interact with your 123 | application's domain model. Here you'll have all parts of the application 124 | configured, just like it is when the application is running. You can inspect 125 | domain models, change values, and save to the database. Starting the script 126 | without arguments will launch it in the development environment. 127 | 128 | To start the console, run rails console from the application 129 | directory. 130 | 131 | Options: 132 | 133 | * Passing the -s, --sandbox argument will rollback any modifications 134 | made to the database. 135 | * Passing an environment name as an argument will load the corresponding 136 | environment. Example: rails console production. 137 | 138 | To reload your controllers and models after launching the console run 139 | reload! 140 | 141 | More information about irb can be found at: 142 | link:http://www.rubycentral.org/pickaxe/irb.html 143 | 144 | 145 | == dbconsole 146 | 147 | You can go to the command line of your database directly through rails 148 | dbconsole. You would be connected to the database with the credentials 149 | defined in database.yml. Starting the script without arguments will connect you 150 | to the development database. Passing an argument will connect you to a different 151 | database, like rails dbconsole production. Currently works for MySQL, 152 | PostgreSQL and SQLite 3. 153 | 154 | == Description of Contents 155 | 156 | The default directory structure of a generated Ruby on Rails application: 157 | 158 | |-- app 159 | | |-- assets 160 | | |-- images 161 | | |-- javascripts 162 | | `-- stylesheets 163 | | |-- controllers 164 | | |-- helpers 165 | | |-- mailers 166 | | |-- models 167 | | `-- views 168 | | `-- layouts 169 | |-- config 170 | | |-- environments 171 | | |-- initializers 172 | | `-- locales 173 | |-- db 174 | |-- doc 175 | |-- lib 176 | | `-- tasks 177 | |-- log 178 | |-- public 179 | |-- script 180 | |-- test 181 | | |-- fixtures 182 | | |-- functional 183 | | |-- integration 184 | | |-- performance 185 | | `-- unit 186 | |-- tmp 187 | | |-- cache 188 | | |-- pids 189 | | |-- sessions 190 | | `-- sockets 191 | `-- vendor 192 | |-- assets 193 | `-- stylesheets 194 | `-- plugins 195 | 196 | app 197 | Holds all the code that's specific to this particular application. 198 | 199 | app/assets 200 | Contains subdirectories for images, stylesheets, and JavaScript files. 201 | 202 | app/controllers 203 | Holds controllers that should be named like weblogs_controller.rb for 204 | automated URL mapping. All controllers should descend from 205 | ApplicationController which itself descends from ActionController::Base. 206 | 207 | app/models 208 | Holds models that should be named like post.rb. Models descend from 209 | ActiveRecord::Base by default. 210 | 211 | app/views 212 | Holds the template files for the view that should be named like 213 | weblogs/index.html.erb for the WeblogsController#index action. All views use 214 | eRuby syntax by default. 215 | 216 | app/views/layouts 217 | Holds the template files for layouts to be used with views. This models the 218 | common header/footer method of wrapping views. In your views, define a layout 219 | using the layout :default and create a file named default.html.erb. 220 | Inside default.html.erb, call <% yield %> to render the view using this 221 | layout. 222 | 223 | app/helpers 224 | Holds view helpers that should be named like weblogs_helper.rb. These are 225 | generated for you automatically when using generators for controllers. 226 | Helpers can be used to wrap functionality for your views into methods. 227 | 228 | config 229 | Configuration files for the Rails environment, the routing map, the database, 230 | and other dependencies. 231 | 232 | db 233 | Contains the database schema in schema.rb. db/migrate contains all the 234 | sequence of Migrations for your schema. 235 | 236 | doc 237 | This directory is where your application documentation will be stored when 238 | generated using rake doc:app 239 | 240 | lib 241 | Application specific libraries. Basically, any kind of custom code that 242 | doesn't belong under controllers, models, or helpers. This directory is in 243 | the load path. 244 | 245 | public 246 | The directory available for the web server. Also contains the dispatchers and the 247 | default HTML files. This should be set as the DOCUMENT_ROOT of your web 248 | server. 249 | 250 | script 251 | Helper scripts for automation and generation. 252 | 253 | test 254 | Unit and functional tests along with fixtures. When using the rails generate 255 | command, template test files will be generated for you and placed in this 256 | directory. 257 | 258 | vendor 259 | External libraries that the application depends on. Also includes the plugins 260 | subdirectory. If the app has frozen rails, those gems also go here, under 261 | vendor/rails/. This directory is in the load path. 262 | --------------------------------------------------------------------------------