rails-named-routes-options 0.0.1

data/.gitignore

@@ -0,0 +1,12 @@
+*~
+.*.swp
+.#*
+
+.DS_Store
+.cache
+.yardoc
+
+/*.gem
+script/*
+gems/*
+!gems/cache

data/CHANGELOG

@@ -0,0 +1,5 @@
+= Version 0.0.1
+  * NamedRoutesOptions mixin
+  * The mixin is automatically included to the ActionMailer::Base
+  * The mixin is automatically included to the ActionController::Base
+  * Added basic README

data/Gemfile

@@ -0,0 +1,7 @@
+# gems
+gem "action_mailer"
+gem "rspec"
+
+# settings
+bin_path "script"
+bundle_path "gems"

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Jakub Stastny aka Botanicus
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.textile

@@ -0,0 +1,13 @@
+h1. About
+
+This Rails plugin adds @default_named_routes_options@ to the controllers and mailers. It comes handy for example when you are working on mailers. You have to specify the whole URI in your links, because otherwise these links obviously can't work in these emails. To ensure this works, you have to specify a host via @default_url_options@ method and then you need to specify @only_path: false@ for each link in your mailer views. This is pretty annoying and of course when you forget about it, your clients won't be very happy.
+
+h1. Usage
+
+<pre>
+# this comes from Rails itself
+ActionMailer::Base.default_url_options[:host] = "http://example.com"
+
+# and this from the plugin
+ActionMailer::Base.default_named_routes_options[:only_path] = false
+</pre>

data/lib/rails-named-routes-options.rb

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+# === Usage ===
+# class InvitationsMailer < ActionMailer::Base
+#   default_named_routes_options[:only_path] = false
+# end
+#
+# or just:
+# ActionMailer::Base.default_named_routes_options[:only_path] = false
+
+module NamedRoutesOptions
+  def routes_names
+    methods = self.instance_methods
+    methods.grep(/_path$/).inject(Array.new) do |result, method|
+      name = method.match(/^(.+)_path$/)[1]
+      result.push(name) if methods.include?("#{name}_url")
+      result
+    end
+  end
+
+  # NOTE: this can't be a class variable, because class variables are shared
+  attr_writer :default_named_routes_options
+  def default_named_routes_options
+    @default_named_routes_options ||= Hash.new
+  end
+
+  def self.extended(mailer)
+    super(mailer)
+    mailer.class_eval do
+      self.routes_names.each do |route|
+        helper_method "#{route}_path", "#{route}_url"
+        define_method("#{route}_path") do |*args|
+          options = args.last.is_a?(Hash) ? args.pop : Hash.new
+          args.push(options.reverse_merge!(:only_path => false))
+          super(*args)
+        end
+
+        alias_method "#{route}_url", "#{route}_path"
+      end
+    end
+  end
+end
+
+ActionMailer::Base.extend(NamedRoutesOptions) if defined?(ActionMailer)
+ActionController::Base.extend(NamedRoutesOptions) if defined?(ActionController)

data/rails-named-routes-options.gemspec

@@ -0,0 +1,34 @@
+#!/usr/bin/env gem build
+# encoding: utf-8
+
+require "base64"
+
+Gem::Specification.new do |s|
+  s.name = "rails-named-routes-options"
+  s.version = "0.0.1"
+  s.authors = ["Jakub Stastny aka Botanicus"]
+  s.homepage = "http://github.com/botanicus/rails-named-routes-options"
+  s.summary = "This Rails plugin adds default_named_routes_options to your controllers and mailers"
+  s.description = "#{s.summary}, so you can specify default options for named routes like ActionMailer::Base.default_named_routes_options[:only_path] = false"
+  s.cert_chain = nil
+  s.email = Base64.decode64("c3Rhc3RueUAxMDFpZGVhcy5jeg==\n")
+  s.has_rdoc = true
+
+  # files
+  s.files = `git ls-files`.split("\n")
+  s.require_paths = ["lib"]
+
+  # runtime dependencies
+  s.add_dependency "actionpack" # and probably actionmailer, but hey, it's up to you mate
+
+  begin
+    require "changelog"
+  rescue LoadError
+    warn "You have to have changelog gem installed for post install message"
+  else
+    s.post_install_message = CHANGELOG.new.version_changes
+  end
+
+  # RubyForge
+  s.rubyforge_project = "rails-named-routes-options"
+end

data/rails-named-routes-options.pre.gemspec

@@ -0,0 +1,8 @@
+#!/usr/bin/env gem build
+# encoding: utf-8
+
+# You might think this is a terrible mess and guess what, you're
+# right mate! However say thanks to authors of RubyGems, not me.
+eval(File.read("rails-named-routes-options.gemspec")).tap do |specification|
+  specification.version = "#{specification.version}.pre"
+end

data/spec/rails-named-routes-options_spec.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+
+require_relative "spec_helper"
+
+describe Rails-named-routes-options do
+  it "should have VERSION constant" do
+    Rails-named-routes-options::VERSION.should be_kind_of(String)
+    Rails-named-routes-options::VERSION.should match(/^\d+\.\d+\.\d+$/)
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,5 @@
+--colour
+--format
+progress
+--loadby
+mtime

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+# constants
+SPEC_ROOT = File.dirname(__FILE__)
+ROOT      = File.expand_path(File.join(SPEC_ROOT, ".."))
+LIBDIR    = File.join(ROOT, "lib")
+
+# load paths
+$:.unshift(LIBDIR)
+
+require "spec" # so you can run ruby spec/rails-named-routes-options/whatever_spec.rb

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: rails-named-routes-options
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jakub Stastny aka Botanicus
+autorequire: 
+bindir: bin
+cert_chain: 
+date: 2010-01-15 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: This Rails plugin adds default_named_routes_options to your controllers and mailers, so you can specify default options for named routes like ActionMailer::Base.default_named_routes_options[:only_path] = false
+email: stastny@101ideas.cz
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- CHANGELOG
+- Gemfile
+- LICENSE
+- README.textile
+- lib/rails-named-routes-options.rb
+- rails-named-routes-options.gemspec
+- rails-named-routes-options.pre.gemspec
+- spec/rails-named-routes-options_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/botanicus/rails-named-routes-options
+licenses: []
+
+post_install_message: "[\e[32mVersion 0.0.1\e[0m] NamedRoutesOptions mixin\n\
+  [\e[32mVersion 0.0.1\e[0m] The mixin is automatically included to the ActionMailer::Base\n\
+  [\e[32mVersion 0.0.1\e[0m] The mixin is automatically included to the ActionController::Base\n\
+  [\e[32mVersion 0.0.1\e[0m] Added basic README\n"
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: rails-named-routes-options
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: This Rails plugin adds default_named_routes_options to your controllers and mailers
+test_files: []
+