├── spec ├── dummy │ ├── log │ │ └── .gitkeep │ ├── app │ │ ├── mailers │ │ │ └── .gitkeep │ │ ├── models │ │ │ └── .gitkeep │ │ ├── helpers │ │ │ └── application_helper.rb │ │ ├── controllers │ │ │ ├── dummy_controller.rb │ │ │ └── application_controller.rb │ │ ├── views │ │ │ ├── dummy │ │ │ │ └── index.html.erb │ │ │ └── layouts │ │ │ │ └── application.html.erb │ │ └── assets │ │ │ ├── stylesheets │ │ │ └── application.css │ │ │ └── javascripts │ │ │ └── application.js │ ├── lib │ │ └── assets │ │ │ └── .gitkeep │ ├── public │ │ ├── favicon.ico │ │ ├── 500.html │ │ ├── 422.html │ │ └── 404.html │ ├── config │ │ ├── routes.rb │ │ ├── environment.rb │ │ ├── locales │ │ │ └── en.yml │ │ ├── initializers │ │ │ ├── mime_types.rb │ │ │ ├── backtrace_silencers.rb │ │ │ ├── session_store.rb │ │ │ ├── secret_token.rb │ │ │ ├── wrap_parameters.rb │ │ │ └── inflections.rb │ │ ├── boot.rb │ │ ├── database.yml │ │ ├── environments │ │ │ ├── development.rb │ │ │ ├── test.rb │ │ │ └── production.rb │ │ └── application.rb │ ├── config.ru │ ├── Rakefile │ ├── script │ │ └── rails │ └── README.rdoc ├── spec_helper.rb └── features │ └── asset_integration_spec.rb ├── app ├── assets │ ├── images │ │ └── outdatedbrowser_rails │ │ │ └── .gitkeep │ ├── javascripts │ │ └── outdatedbrowser │ │ │ ├── require_outdatedbrowser.js │ │ │ └── outdatedBrowser.js │ └── stylesheets │ │ ├── outdatedbrowser_rails │ │ └── application.css │ │ └── outdatedbrowser │ │ └── outdatedBrowser.css └── views │ ├── layouts │ └── outdatedbrowser_rails │ │ └── application.html.erb │ └── outdatedbrowser │ └── _outdatedbrowser.html.erb ├── config ├── routes.rb └── locales │ └── en.yml ├── lib ├── outdatedbrowser_rails │ ├── version.rb │ └── engine.rb ├── outdatedbrowser_rails.rb └── tasks │ └── outdatedbrowser_rails_tasks.rake ├── .gitignore ├── .gitmodules ├── script └── rails ├── Gemfile ├── outdatedbrowser_rails.gemspec ├── MIT-LICENSE ├── Rakefile ├── README.md └── README.rdoc /spec/dummy/log/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /spec/dummy/app/mailers/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /spec/dummy/app/models/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /spec/dummy/lib/assets/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /spec/dummy/public/favicon.ico: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /app/assets/images/outdatedbrowser_rails/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /config/routes.rb: -------------------------------------------------------------------------------- 1 | OutdatedbrowserRails::Engine.routes.draw do 2 | end 3 | -------------------------------------------------------------------------------- /spec/dummy/app/helpers/application_helper.rb: -------------------------------------------------------------------------------- 1 | module ApplicationHelper 2 | end 3 | -------------------------------------------------------------------------------- /lib/outdatedbrowser_rails/version.rb: -------------------------------------------------------------------------------- 1 | module OutdatedbrowserRails 2 | VERSION = "1.0.2.0" 3 | end 4 | -------------------------------------------------------------------------------- /spec/dummy/config/routes.rb: -------------------------------------------------------------------------------- 1 | Rails.application.routes.draw do 2 | root to: 'dummy#index' 3 | end 4 | -------------------------------------------------------------------------------- /lib/outdatedbrowser_rails.rb: -------------------------------------------------------------------------------- 1 | require "outdatedbrowser_rails/engine" 2 | 3 | module OutdatedbrowserRails 4 | end 5 | -------------------------------------------------------------------------------- /spec/dummy/app/controllers/dummy_controller.rb: -------------------------------------------------------------------------------- 1 | class DummyController < ApplicationController 2 | def index 3 | end 4 | end 5 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .bundle/ 2 | log/*.log 3 | pkg/ 4 | spec/dummy/db/*.sqlite3 5 | spec/dummy/log/*.log 6 | spec/dummy/tmp/ 7 | spec/dummy/.sass-cache 8 | -------------------------------------------------------------------------------- /.gitmodules: -------------------------------------------------------------------------------- 1 | [submodule "vendor/outdated-browser"] 2 | path = vendor/outdated-browser 3 | url = https://github.com/burocratik/outdated-browser 4 | -------------------------------------------------------------------------------- /spec/dummy/app/controllers/application_controller.rb: -------------------------------------------------------------------------------- 1 | class ApplicationController < ActionController::Base 2 | protect_from_forgery 3 | end 4 | -------------------------------------------------------------------------------- /lib/tasks/outdatedbrowser_rails_tasks.rake: -------------------------------------------------------------------------------- 1 | # desc "Explaining what the task does" 2 | # task :outdatedbrowser_rails do 3 | # # Task goes here 4 | # end 5 | -------------------------------------------------------------------------------- /lib/outdatedbrowser_rails/engine.rb: -------------------------------------------------------------------------------- 1 | module OutdatedbrowserRails 2 | class Engine < ::Rails::Engine 3 | isolate_namespace OutdatedbrowserRails 4 | end 5 | end 6 | -------------------------------------------------------------------------------- /spec/dummy/app/views/dummy/index.html.erb: -------------------------------------------------------------------------------- 1 | <%= render 'outdatedbrowser/outdatedbrowser' %> 2 | 3 | <%= javascript_include_tag 'outdatedbrowser/require_outdatedbrowser' %> 4 | -------------------------------------------------------------------------------- /spec/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 | -------------------------------------------------------------------------------- /spec/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 | -------------------------------------------------------------------------------- /config/locales/en.yml: -------------------------------------------------------------------------------- 1 | en: 2 | outdatedbrowser: 3 | out_of_date: 'Your browser is out-of-date!' 4 | suggest_update: 'Update your browser to view this website correctly.' 5 | update_now: 'Update my browser now' -------------------------------------------------------------------------------- /spec/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 | -------------------------------------------------------------------------------- /spec/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 | -------------------------------------------------------------------------------- /spec/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__) -------------------------------------------------------------------------------- /spec/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 | -------------------------------------------------------------------------------- /spec/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 | -------------------------------------------------------------------------------- /spec/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 | -------------------------------------------------------------------------------- /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 | ENGINE_ROOT = File.expand_path('../..', __FILE__) 5 | ENGINE_PATH = File.expand_path('../../lib/outdatedbrowser_rails/engine', __FILE__) 6 | 7 | require 'rails/all' 8 | require 'rails/engine/commands' 9 | -------------------------------------------------------------------------------- /app/views/layouts/outdatedbrowser_rails/application.html.erb: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | OutdatedbrowserRails 5 | <%= stylesheet_link_tag "outdatedbrowser_rails/application", :media => "all" %> 6 | <%= javascript_include_tag "outdatedbrowser_rails/application" %> 7 | <%= csrf_meta_tags %> 8 | 9 | 10 | 11 | <%= yield %> 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /app/views/outdatedbrowser/_outdatedbrowser.html.erb: -------------------------------------------------------------------------------- 1 |
2 |
3 | <%= t('outdatedbrowser.out_of_date') %> 4 |
5 |

6 | <%= t('outdatedbrowser.suggest_update') %> 7 | 8 | <%= t('outdatedbrowser.update_now') %> 9 | 10 |

11 |

12 | × 13 |

14 |
15 | -------------------------------------------------------------------------------- /spec/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 | -------------------------------------------------------------------------------- /spec/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 | -------------------------------------------------------------------------------- /spec/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 = '6fce1f15c07183bc847edfb6531f8213d86860676766bcb189c06293e8ff88801bb418cb677400eaacea4f29990ae2d9659c8da4567129307cc425f25dfdebfc' 8 | -------------------------------------------------------------------------------- /spec/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 | -------------------------------------------------------------------------------- /app/assets/javascripts/outdatedbrowser/require_outdatedbrowser.js: -------------------------------------------------------------------------------- 1 | 2 | //event listener: DOM ready 3 | function addLoadEvent(func) { 4 | var oldonload = window.onload; 5 | if (typeof window.onload != 'function') { 6 | window.onload = func; 7 | } else { 8 | window.onload = function() { 9 | oldonload(); 10 | func(); 11 | } 12 | } 13 | } 14 | //call plugin function after DOM ready 15 | addLoadEvent( 16 | outdatedBrowser({ 17 | bgColor: '#f25648', 18 | color: '#ffffff', 19 | lowerThan: 'transform' 20 | }) 21 | ); 22 | -------------------------------------------------------------------------------- /spec/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 | -------------------------------------------------------------------------------- /app/assets/stylesheets/outdatedbrowser_rails/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 | -------------------------------------------------------------------------------- /spec/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 | *= require outdatedbrowser/outdatedBrowser 14 | */ 15 | -------------------------------------------------------------------------------- /spec/spec_helper.rb: -------------------------------------------------------------------------------- 1 | ENV['RAILS_ENV'] ||= 'test' 2 | require File.expand_path("../dummy/config/environment.rb", __FILE__) 3 | require 'rspec/rails' 4 | # require 'rspec/autorun' 5 | require 'capybara/rspec' 6 | 7 | Rails.backtrace_cleaner.remove_silencers! 8 | # Load support files 9 | Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f } 10 | 11 | RSpec.configure do |config| 12 | include Capybara::DSL 13 | config.mock_with :rspec 14 | config.use_transactional_fixtures = true 15 | config.infer_base_class_for_anonymous_controllers = false 16 | config.order = "random" 17 | config.color = true 18 | config.tty = true 19 | config.formatter = :documentation 20 | end 21 | -------------------------------------------------------------------------------- /Gemfile: -------------------------------------------------------------------------------- 1 | source "https://rubygems.org" 2 | 3 | # Declare your gem's dependencies in outdatedbrowser_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 | gem "sqlite3" 11 | 12 | # Declare any dependencies that are still in development here instead of in 13 | # your gemspec. These might include edge Rails or gems from your path or 14 | # Git. Remember to move these dependencies to your gemspec before releasing 15 | # your gem to rubygems.org. 16 | 17 | # To use debugger 18 | # gem 'debugger' 19 | -------------------------------------------------------------------------------- /spec/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: db/test.sqlite3 18 | pool: 5 19 | timeout: 5000 20 | 21 | production: 22 | adapter: sqlite3 23 | database: db/production.sqlite3 24 | pool: 5 25 | timeout: 5000 26 | -------------------------------------------------------------------------------- /spec/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 | -------------------------------------------------------------------------------- /spec/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 | //= require outdatedbrowser/outdatedBrowser 17 | -------------------------------------------------------------------------------- /spec/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 | -------------------------------------------------------------------------------- /spec/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 | -------------------------------------------------------------------------------- /spec/features/asset_integration_spec.rb: -------------------------------------------------------------------------------- 1 | require 'spec_helper' 2 | 3 | describe 'static assets integration' do 4 | it 'provides outdatedBrowser.js on the asset pipeline' do 5 | visit '/assets/outdatedbrowser/outdatedBrowser.js' 6 | expect(page.text).to match(/outdatedBrowser/) 7 | end 8 | 9 | it 'provides require_outdatedbrowser.js on the asset pipeline' do 10 | visit '/assets/outdatedbrowser/require_outdatedbrowser.js' 11 | expect(page.text).to match(/outdatedBrowser/) 12 | end 13 | 14 | it 'provides outdatedBrowser.css on the asset pipeline' do 15 | visit '/assets/outdatedbrowser/outdatedBrowser.css' 16 | expect(page.text).to match(/Outdated Browser/) 17 | end 18 | 19 | it 'provides a partial with the div on the asset pipeline' do 20 | visit '/' 21 | expect(page).to have_selector('#outdated') 22 | end 23 | end 24 | -------------------------------------------------------------------------------- /outdatedbrowser_rails.gemspec: -------------------------------------------------------------------------------- 1 | $:.push File.expand_path("../lib", __FILE__) 2 | 3 | # Maintain your gem's version: 4 | require "outdatedbrowser_rails/version" 5 | 6 | # Describe your gem and declare its dependencies: 7 | Gem::Specification.new do |s| 8 | s.name = "outdatedbrowser_rails" 9 | s.version = OutdatedbrowserRails::VERSION 10 | s.authors = ["Luisa Lima"] 11 | s.email = ["luisamoyalima@gmail.com"] 12 | s.homepage = "https://github.com/luisalima/outdatedbrowser_rails" 13 | s.summary = "Adds outdatedbrowser assets to the rails asset pipeline." 14 | s.description = "A gem to automate using outdated-browser with Rails >= 3." 15 | 16 | s.files = Dir["{app,config,db,lib}/**/*"] + ["MIT-LICENSE", "Rakefile", "README.rdoc"] 17 | s.licenses = ['MIT'] 18 | 19 | s.add_dependency "rails", '~> 3.2', '>= 3.2.16' 20 | s.add_dependency "i18n", '~> 0.6' 21 | 22 | s.add_development_dependency "capybara", '~> 2.4' 23 | s.add_development_dependency "rspec-rails", '~> 3.0' 24 | s.test_files = Dir["spec/**/*"] 25 | end 26 | -------------------------------------------------------------------------------- /MIT-LICENSE: -------------------------------------------------------------------------------- 1 | Copyright 2014 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 | -------------------------------------------------------------------------------- /app/assets/stylesheets/outdatedbrowser/outdatedBrowser.css: -------------------------------------------------------------------------------- 1 | /*!-------------------------------------------------------------------- 2 | STYLES "Outdated Browser" 3 | Version: 1.0.2 - 2014 4 | author: Burocratik 5 | website: http://www.burocratik.com 6 | * @preserve 7 | -----------------------------------------------------------------------*/ 8 | #outdated{ 9 | display: none; position: fixed; top: 0; left: 0; width: 100%; height: 170px; 10 | text-align: center; text-transform: uppercase; z-index:1500; 11 | background-color: #f25648; color: #ffffff; 12 | } 13 | * html #outdated{position: absolute;} 14 | #outdated h6{font-size: 25px; line-height: 25px; margin: 30px 0 10px;} 15 | #outdated p{font-size: 12px; line-height: 12px;} 16 | #outdated #btnUpdateBrowser{ 17 | display: block; position: relative; padding: 10px 20px; margin: 30px auto 0; width: 180px; 18 | color: #ffffff; text-decoration: none; border: 2px solid #ffffff; cursor: pointer; 19 | } 20 | #outdated #btnUpdateBrowser:hover{color: #f25648; background-color:#ffffff;} 21 | #outdated .last{position: absolute; top: 20px; right: 30px; width: 15px; height: 15px;} 22 | #outdated #btnCloseUpdateBrowser{ 23 | display: block; position: absolute; left: 0; top: 0; width: 100%; height: 100%; 24 | text-decoration: none; color: #ffffff; font-size: 36px; 25 | } -------------------------------------------------------------------------------- /spec/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 | # Log error messages when you accidentally call methods on nil. 10 | config.whiny_nils = true 11 | 12 | # Show full error reports and disable caching 13 | config.consider_all_requests_local = true 14 | config.action_controller.perform_caching = false 15 | 16 | # Don't care if the mailer can't send 17 | config.action_mailer.raise_delivery_errors = false 18 | 19 | # Print deprecation notices to the Rails logger 20 | config.active_support.deprecation = :log 21 | 22 | # Only use best-standards-support built into browsers 23 | config.action_dispatch.best_standards_support = :builtin 24 | 25 | # Raise exception on mass assignment protection for Active Record models 26 | config.active_record.mass_assignment_sanitizer = :strict 27 | 28 | # Log the query plan for queries taking more than this (works 29 | # with SQLite, MySQL, and PostgreSQL) 30 | config.active_record.auto_explain_threshold_in_seconds = 0.5 31 | 32 | # Do not compress assets 33 | config.assets.compress = false 34 | 35 | # Expands the lines which load the assets 36 | config.assets.debug = true 37 | end 38 | -------------------------------------------------------------------------------- /spec/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 | # Log error messages when you accidentally call methods on nil 15 | config.whiny_nils = true 16 | 17 | # Show full error reports and disable caching 18 | config.consider_all_requests_local = true 19 | config.action_controller.perform_caching = false 20 | 21 | # Raise exceptions instead of rendering exception templates 22 | config.action_dispatch.show_exceptions = false 23 | 24 | # Disable request forgery protection in test environment 25 | config.action_controller.allow_forgery_protection = false 26 | 27 | # Tell Action Mailer not to deliver emails to the real world. 28 | # The :test delivery method accumulates sent emails in the 29 | # ActionMailer::Base.deliveries array. 30 | config.action_mailer.delivery_method = :test 31 | 32 | # Raise exception on mass assignment protection for Active Record models 33 | config.active_record.mass_assignment_sanitizer = :strict 34 | 35 | # Print deprecation notices to the stderr 36 | config.active_support.deprecation = :stderr 37 | end 38 | -------------------------------------------------------------------------------- /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 = 'OutdatedbrowserRails' 18 | rdoc.options << '--line-numbers' 19 | rdoc.rdoc_files.include('README.rdoc') 20 | rdoc.rdoc_files.include('lib/**/*.rb') 21 | end 22 | 23 | APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__) 24 | load 'rails/tasks/engine.rake' 25 | 26 | Bundler::GemHelper.install_tasks 27 | 28 | require 'rspec/core' 29 | require 'rspec/core/rake_task' 30 | desc "Run all specs in spec directory (excluding plugin specs)" 31 | RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare') 32 | task :default => :spec 33 | 34 | dependencies = { 35 | javascripts: ['outdatedBrowser.js'], 36 | stylesheets: ['outdatedBrowser.css'] 37 | } 38 | 39 | origin = 'vendor/outdated-browser/outdatedbrowser' 40 | 41 | desc "Clean assets" 42 | task :clean do 43 | dependencies.each do |filetype, filenames| 44 | filenames.each do |filename| 45 | rm_rf "app/assets/#{filetype}/outdatedbrowser/#{filename}" 46 | end 47 | end 48 | end 49 | 50 | namespace :generate do 51 | desc "Generate assets" 52 | task :assets do 53 | Rake.rake_output_message "Copying javascripts" 54 | target_dir = "app/assets/javascripts/outdatedbrowser" 55 | mkdir_p target_dir 56 | puts FileUtils.cp(Dir.glob("#{origin}/outdatedBrowser.js"), target_dir) 57 | 58 | Rake.rake_output_message "Copying css files" 59 | target_dir = "app/assets/stylesheets/outdatedbrowser" 60 | mkdir_p target_dir 61 | puts FileUtils.cp(Dir.glob("#{origin}/outdatedBrowser.css"), target_dir) 62 | end 63 | end 64 | -------------------------------------------------------------------------------- /spec/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 nil and saved in location specified by config.assets.prefix 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 | 64 | # Log the query plan for queries taking more than this (works 65 | # with SQLite, MySQL, and PostgreSQL) 66 | # config.active_record.auto_explain_threshold_in_seconds = 0.5 67 | end 68 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # OutdatedbrowserRails 2 | 3 | This project bundles the excellent Burocratik's 4 | [Outdated Browser](https://github.com/burocratik/outdated-browser) 5 | detector for use with the rails 3.1+ asset pipeline. 6 | 7 | [![Gem Version](https://badge.fury.io/rb/outdatedbrowser_rails.svg)](http://badge.fury.io/rb/outdatedbrowser_rails) 8 | 9 | ## Installation 10 | 11 | Add this line to your application's Gemfile: 12 | 13 | ```ruby 14 | gem 'outdatedbrowser_rails' 15 | ``` 16 | 17 | ## Usage 18 | 19 | ### Including Outdated Browser assets 20 | 21 | Add this line to your `application.js`: 22 | 23 | ```js 24 | //= require outdatedbrowser/outdatedBrowser 25 | ``` 26 | 27 | Add this line to your `application.css` || `application.scss`: 28 | 29 | ```css 30 | //= require outdatedbrowser/outdatedBrowser 31 | ``` 32 | ### Using the gem's strategy to require Outdated Browser 33 | 34 | In the view where you want to use this, add: 35 | 36 | ```erb 37 | <%= render 'outdatedbrowser/outdatedbrowser' %> 38 | ``` 39 | 40 | At the **bottom** of the body (make sure it's included **after** 41 | _application.js_), add: 42 | 43 | ```erb 44 | <%= javascript_include_tag 'outdatedbrowser/require_outdatedbrowser' %> 45 | ``` 46 | 47 | The gem uses `i18n` for the message strings, you can use other strings 48 | in your application by 49 | [looking at the keys](https://github.com/luisalima/outdatedbrowser_rails/blob/master/config/locales/en.yml) 50 | and overriding them. 51 | 52 | ### Manual approach to require Outdated Browser 53 | 54 | See the [Outdated Browser usage guide](https://github.com/burocratik/outdated-browser#how-to-use-it). 55 | 56 | ### Testing the integration in your app 57 | 58 | * Of course, ideally use an outdated browser to test. 59 | * With an up-to-date browser: 60 | * In the view where you included the partial, check that `#outdated` 61 | is present. 62 | * See how it looks: `$('#outdated').show()` 63 | 64 | ## Contributing 65 | 66 | Feel free to open an issue if you find something that could be improved. 67 | 68 | Here are a couple of things worth noting: 69 | 70 | * This is a mountable rails engine tested with `rspec` and `capybara`. 71 | For more info or a good reference to make your own, see 72 | [this good tutorial](http://viget.com/extend/rails-engine-testing-with-rspec-capybara-and-factorygirl). 73 | * The rake task `rake generate:assets` copies the assets from the 74 | `vendor/outdated-browser` folder (which is a git submodule) to the 75 | engine `app` folder. 76 | * The rake task `clean` cleans the copied assets. 77 | * To run tests, use `rspec spec`. 78 | 79 | Finally, to contribute: 80 | 81 | 1. Fork it 82 | 2. Create your feature branch (`git checkout -b my-new-feature`) 83 | 3. Run tests using `rspec spec`, and make sure they are green! 84 | 4. Add tests to `spec/features`, if necessary. 85 | 5. Commit your changes (`git commit -am 'Add some feature'`) 86 | 6. Push to the branch (`git push origin my-new-feature`) 87 | 7. Create new Pull Request 88 | -------------------------------------------------------------------------------- /README.rdoc: -------------------------------------------------------------------------------- 1 | # OutdatedbrowserRails 2 | 3 | This project bundles the excellent Burocratik's 4 | [Outdated Browser](https://github.com/burocratik/outdated-browser) 5 | detector for use with the rails 3.1+ asset pipeline. 6 | 7 | {Gem Version}[http://badge.fury.io/rb/outdatedbrowser_rails] 8 | 9 | ## Installation 10 | 11 | Add this line to your application's Gemfile: 12 | 13 | ```ruby 14 | gem 'outdatedbrowser_rails' 15 | ``` 16 | 17 | ## Usage 18 | 19 | ### Including Outdated Browser assets 20 | 21 | Add this line to your `application.js`: 22 | 23 | ```js 24 | //= require outdatedbrowser/outdatedBrowser 25 | ``` 26 | 27 | Add this line to your `application.css` || `application.scss`: 28 | 29 | ```css 30 | //= require outdatedbrowser/outdatedBrowser 31 | ``` 32 | ### Using the gem's strategy to require Outdated Browser 33 | 34 | In the view where you want to use this, add: 35 | 36 | ```erb 37 | <%= render 'outdatedbrowser/outdatedbrowser' %> 38 | ``` 39 | 40 | At the **bottom** of the body (make sure it's included **after** 41 | _application.js_), add: 42 | 43 | ```erb 44 | <%= javascript_include_tag 'outdatedbrowser/require_outdatedbrowser' %> 45 | ``` 46 | 47 | The gem uses `i18n` for the message strings, you can use other strings 48 | in your application by 49 | [looking at the keys](https://github.com/luisalima/outdatedbrowser_rails/blob/master/config/locales/en.yml) 50 | and overriding them. 51 | 52 | ### Manual approach to require Outdated Browser 53 | 54 | See the [Outdated Browser usage guide](https://github.com/burocratik/outdated-browser#how-to-use-it). 55 | 56 | #### Testing the integration in your app 57 | 58 | * Of course, ideally use an outdated browser to test. 59 | * With an up-to-date browser: 60 | * In the view where you included the partial, check that `#outdated` 61 | is present. 62 | * See how it looks: `$('#outdated').show() 63 | 64 | ## Contributing 65 | 66 | Feel free to open an issue if you find something that could be improved. 67 | 68 | Here are a couple of things worth noting: 69 | 70 | * This is a mountable rails engine tested with `rspec` and `capybara`. 71 | For more info or a good reference to make your own, see 72 | [this good tutorial](http://viget.com/extend/rails-engine-testing-with-rspec-capybara-and-factorygirl). 73 | * The rake task `rake generate:assets` copies the assets from the 74 | `vendor/outdated-browser` folder (which is a git submodule) to the 75 | engine `app` folder. 76 | * The rake task `clean` cleans the copied assets. 77 | * To run tests, use `rspec spec`. 78 | 79 | Finally, to contribute: 80 | 81 | 1. Fork it 82 | 2. Create your feature branch (`git checkout -b my-new-feature`) 83 | 3. Run tests using `rspec spec`, and make sure they are green! 84 | 4. Add tests to `spec/features`, if necessary. 85 | 5. Commit your changes (`git commit -am 'Add some feature'`) 86 | 6. Push to the branch (`git push origin my-new-feature`) 87 | 7. Create new Pull Request 88 | -------------------------------------------------------------------------------- /spec/dummy/config/application.rb: -------------------------------------------------------------------------------- 1 | require File.expand_path('../boot', __FILE__) 2 | 3 | # Pick the frameworks you want: 4 | require "active_record/railtie" 5 | require "action_controller/railtie" 6 | require "action_mailer/railtie" 7 | require "active_resource/railtie" 8 | require "sprockets/railtie" 9 | # require "rails/test_unit/railtie" 10 | 11 | Bundler.require(*Rails.groups) 12 | require "outdatedbrowser_rails" 13 | 14 | module Dummy 15 | class Application < Rails::Application 16 | # Settings in config/environments/* take precedence over those specified here. 17 | # Application configuration should go into files in config/initializers 18 | # -- all .rb files in that directory are automatically loaded. 19 | 20 | # Custom directories with classes and modules you want to be autoloadable. 21 | # config.autoload_paths += %W(#{config.root}/extras) 22 | 23 | # Only load the plugins named here, in the order given (default is alphabetical). 24 | # :all can be used as a placeholder for all plugins not explicitly named. 25 | # config.plugins = [ :exception_notification, :ssl_requirement, :all ] 26 | 27 | # Activate observers that should always be running. 28 | # config.active_record.observers = :cacher, :garbage_collector, :forum_observer 29 | 30 | # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone. 31 | # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC. 32 | # config.time_zone = 'Central Time (US & Canada)' 33 | 34 | # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded. 35 | # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s] 36 | # config.i18n.default_locale = :de 37 | 38 | # Configure the default encoding used in templates for Ruby 1.9. 39 | config.encoding = "utf-8" 40 | 41 | # Configure sensitive parameters which will be filtered from the log file. 42 | config.filter_parameters += [:password] 43 | 44 | # Enable escaping HTML in JSON. 45 | config.active_support.escape_html_entities_in_json = true 46 | 47 | # Use SQL instead of Active Record's schema dumper when creating the database. 48 | # This is necessary if your schema can't be completely dumped by the schema dumper, 49 | # like if you have constraints or database-specific column types 50 | # config.active_record.schema_format = :sql 51 | 52 | # Enforce whitelist mode for mass assignment. 53 | # This will create an empty whitelist of attributes available for mass-assignment for all models 54 | # in your app. As such, your models will need to explicitly whitelist or blacklist accessible 55 | # parameters by using an attr_accessible or attr_protected declaration. 56 | config.active_record.whitelist_attributes = true 57 | 58 | # Enable the asset pipeline 59 | config.assets.enabled = true 60 | 61 | # Version of your assets, change this if you want to expire all your assets 62 | config.assets.version = '1.0' 63 | end 64 | end 65 | 66 | -------------------------------------------------------------------------------- /app/assets/javascripts/outdatedbrowser/outdatedBrowser.js: -------------------------------------------------------------------------------- 1 | /*!-------------------------------------------------------------------- 2 | JAVASCRIPT "Outdated Browser" 3 | Version: 1.0.2 - 2014 4 | author: Burocratik 5 | website: http://www.burocratik.com 6 | * @preserve 7 | -----------------------------------------------------------------------*/ 8 | var outdatedBrowser = function(options) { 9 | 10 | //Variable definition 11 | var outdated = document.getElementById("outdated"); 12 | var btnClose = document.getElementById("btnCloseUpdateBrowser"); 13 | var btnUpdate = document.getElementById("btnUpdateBrowser"); 14 | 15 | // Default settings 16 | this.defaultOpts = { 17 | bgColor: '#F25648', 18 | color: '#FFFFFF', 19 | lowerThan: 'transform' 20 | }; 21 | 22 | if (options) { 23 | this.defaultOpts.bgColor = options.bgColor; 24 | this.defaultOpts.color = options.color; 25 | 26 | //assign css3 property to IE browser version 27 | if(options.lowerThan == 'IE8' || options.lowerThan == 'borderSpacing') { 28 | options.lowerThan = 'borderSpacing'; 29 | } else if (options.lowerThan == 'IE9' || options.lowerThan == 'boxShadow') { 30 | options.lowerThan = 'boxShadow'; 31 | } else if (options.lowerThan == 'IE10' || options.lowerThan == 'transform' || options.lowerThan == '' || typeof options.lowerThan === "undefined") { 32 | options.lowerThan = 'transform'; 33 | } else if (options.lowerThan == 'IE11' || options.lowerThan == 'borderImage') { 34 | options.lowerThan = 'borderImage'; 35 | } 36 | 37 | this.defaultOpts.lowerThan = options.lowerThan; 38 | 39 | bkgColor = this.defaultOpts.bgColor; 40 | txtColor = this.defaultOpts.color; 41 | cssProp = this.defaultOpts.lowerThan; 42 | } else { 43 | bkgColor = this.defaultOpts.bgColor; 44 | txtColor = this.defaultOpts.color; 45 | cssProp = this.defaultOpts.lowerThan; 46 | } 47 | 48 | //Define opacity and fadeIn/fadeOut functions 49 | var done = true; 50 | 51 | function function_opacity(opacity_value) { 52 | outdated.style.opacity = opacity_value / 100; 53 | outdated.style.filter = 'alpha(opacity=' + opacity_value + ')'; 54 | } 55 | 56 | function function_fade_out(opacity_value) { 57 | function_opacity(opacity_value); 58 | if (opacity_value == 1) { 59 | outdated.style.display = 'none'; 60 | done = true; 61 | } 62 | } 63 | 64 | function function_fade_in(opacity_value) { 65 | function_opacity(opacity_value); 66 | if (opacity_value == 1) { 67 | outdated.style.display = 'block'; 68 | } 69 | if (opacity_value == 100) { 70 | done = true; 71 | } 72 | } 73 | 74 | //check if element has a particular class 75 | function hasClass(element, cls) { 76 | return (' ' + element.className + ' ').indexOf(' ' + cls + ' ') > -1; 77 | } 78 | 79 | var supports = (function() { 80 | var div = document.createElement('div'), 81 | vendors = 'Khtml Ms O Moz Webkit'.split(' '), 82 | len = vendors.length; 83 | 84 | return function(prop) { 85 | if ( prop in div.style ) return true; 86 | 87 | prop = prop.replace(/^[a-z]/, function(val) { 88 | return val.toUpperCase(); 89 | }); 90 | 91 | while(len--) { 92 | if ( vendors[len] + prop in div.style ) { 93 | return true; 94 | } 95 | } 96 | return false; 97 | }; 98 | })(); 99 | 100 | //check for css3 property support (transform=default) 101 | if ( !supports(''+ cssProp +'') ) { 102 | if (done && outdated.style.opacity !== '1') { 103 | done = false; 104 | for (var i = 1; i <= 100; i++) { 105 | setTimeout((function (x) { 106 | return function () { 107 | function_fade_in(x); 108 | }; 109 | })(i), i * 10); 110 | } 111 | } 112 | //close button 113 | btnClose.onmousedown = function() { 114 | outdated.style.display = 'none'; 115 | return false; 116 | }; 117 | } 118 | 119 | 120 | //check settings attributes 121 | outdated.style.backgroundColor = bkgColor; 122 | //way too hard to put !important on IE6 123 | outdated.style.color = txtColor; 124 | outdated.children[0].style.color = txtColor; 125 | outdated.children[1].style.color = txtColor; 126 | 127 | //check settings attributes 128 | btnUpdate.style.color = txtColor; 129 | btnUpdate.style.borderColor = txtColor; 130 | btnClose.style.color = txtColor; 131 | 132 | //Override the update button color to match the background color 133 | btnUpdate.onmouseover = function() { 134 | this.style.color = bkgColor; 135 | this.style.backgroundColor = txtColor; 136 | }; 137 | btnUpdate.onmouseout = function() { 138 | this.style.color = txtColor; 139 | this.style.backgroundColor = bkgColor; 140 | }; 141 | };//end of function 142 | -------------------------------------------------------------------------------- /spec/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 | | |-- assets 177 | | `-- tasks 178 | |-- log 179 | |-- public 180 | |-- script 181 | |-- test 182 | | |-- fixtures 183 | | |-- functional 184 | | |-- integration 185 | | |-- performance 186 | | `-- unit 187 | |-- tmp 188 | | `-- cache 189 | | `-- assets 190 | `-- vendor 191 | |-- assets 192 | | |-- javascripts 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 | --------------------------------------------------------------------------------