roboto 0.0.2 → 0.1.0

data/.gitignore

@@ -22,3 +22,6 @@ spec/dummy/db/*.sqlite3
 spec/dummy/log/*.log
 spec/dummy/tmp/
 
+
+.DS_Store
+spec/dummy_generator/

data/README.md

@@ -7,36 +7,21 @@ Roboto is a Rails Engine that gives you the ability to specify enviornment speci
 Don't let crawlers access your staging environment. This is [bad for SEO](http://www.seomoz.org/learn-seo/duplicate-content).
 
 ## Installing
-
-First, remove the default, generate robots.txt in your Rails App
+You can add it to your Gemfile with:
 
 ```
-  #> rm public/robots.txt
+gem 'roboto'
 ```
 
-Next, add roboto to your gemfile:
-
+After you need to run the generator:
 ```
-  gem 'roboto'
+#>  rails generate roboto:install
 ```
 
-Then, add robot to your routes (config/routes.rb):
-
-```
-  Rails.application.routes.draw do
-    mount_roboto
-  end
-```
+If you already have robots.txt, it will be kept for your production environment in config/robots/production.txt
 
-You can now specify environment specific robots.txt files in config/robots.
-
-It's recommended for staging that you do disallow crawlers from accessing your site. Once you've created a separate Rails environment for staging, define a config/robots/staging.txt file like so:
-
-```
-  #place this in config/robots/staging.txt
-  User-Agent: *
-  Disallow: /
-```
+You can now specify environment specific robots.txt files in config/robots/.
+By default crawlers are disallow from accessing your site has been made for all your environments.
 
 ## Contributing
 

data/app/controllers/roboto/robots_controller.rb

@@ -8,7 +8,8 @@ module Roboto
 
     protected
     def robot_contents
-      Roboto::ContentProvider.new.contents
+      # process erb template in the context of this controller request
+      Roboto::ContentProvider.new.contents(binding)
     end
 
     def robots_path

data/config/routes.rb

@@ -1,4 +1,4 @@
 Roboto::Engine.routes.draw do
-  get '/robots.txt' => 'Robots#show'
+  get '/' => 'Robots#show'
 end
 

data/lib/generators/roboto/install_generator.rb

@@ -0,0 +1,32 @@
+module Roboto
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+
+      desc "Creates a Roboto locale files to your application."
+
+      def copy_locale
+        empty_directory "config/robots"
+        env_list = Dir.glob("#{destination_root}/config/environments/*")
+        env_list.each do |env_file|
+          env_name = File.basename(env_file, ".rb")
+          unless (env_name == "production" &&  FileTest.exists?("public/robots.txt"))
+            copy_file "robots.txt", "config/robots/#{env_name}.txt"
+          end
+        end
+        if FileTest.exists?("public/robots.txt")
+         copy_file File.join(destination_root + "/public/robots.txt"), "config/robots/production.txt"
+         remove_file "public/robots.txt"
+        end
+      end
+
+      def add_roboto_route
+        route "mount_roboto"
+      end
+
+      def show_readme
+        readme "README" if behavior == :invoke
+      end
+    end
+  end
+end

data/lib/generators/templates/README

@@ -0,0 +1,11 @@
+===============================================================================
+Disallow crawlers from accessing your site has been made for all
+your environments.
+
+If you had a robots.txt in public,
+it was moved to config/robots/production.txt
+
+You can now specify environment specific robots.txt files in config/robots.
+
+Domo arigato!
+===============================================================================

data/lib/generators/templates/robots.txt

@@ -0,0 +1,2 @@
+  User-Agent: *
+  Disallow: /

data/lib/roboto/content_provider.rb

@@ -1,10 +1,18 @@
+require 'erb'
+
 module Roboto
   #provides the content of effective robots.txt file
   class ContentProvider
     # Reads the contents of the effective robots.txt file
     # @return [String] the contents of the effective robots.txt file
-    def contents
-      @contents ||= File.read(path)
+    def contents(custom_binding = nil)
+      return @contents unless @contents.nil?
+
+      @contents = File.read(path)
+      if path.extname == '.erb'
+        @contents = ERB.new(@contents).result(custom_binding ? custom_binding : binding)
+      end
+      @contents
     end
 
     # Determines the most relevant robots.txt file.
@@ -30,7 +38,9 @@ module Roboto
     def lookup_paths
       [
         Rails.root.join("config/robots/#{Rails.env}.txt"),
+        Rails.root.join("config/robots/#{Rails.env}.txt.erb"),
         Rails.root.join(relative_path_to_default),
+        Rails.root.join("#{relative_path_to_default}.erb"),
         Roboto::Engine.root.join(relative_path_to_default)
       ]
     end

data/lib/roboto/routing.rb

@@ -3,7 +3,7 @@ module Roboto
   module Routing
     # convenience function for mounting the roboto rails engine to root
     def mount_roboto
-      mount Roboto::Engine => "/"
+      mount Roboto::Engine => "/robots.txt"
     end
   end
 end

data/lib/roboto/version.rb

@@ -1,4 +1,4 @@
 module Roboto
   #The effective version of roboto
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/roboto.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |gem|
   gem.email         = ['dan.pickett@launchware.com']
   gem.description   = %q{A Rails Engine to help with robots.txt}
   gem.summary       = %q{A Rails Engine to help with robots.txt}
-  gem.homepage      = ""
+  gem.homepage      = "https://github.com/LaunchWare/roboto"
 
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
@@ -19,11 +19,13 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'actionpack', '>= 3.0.0'
 
   gem.add_development_dependency 'rspec-rails', '~> 2.9.0'
+  gem.add_development_dependency 'ammeter'
   gem.add_development_dependency 'capybara'
   gem.add_development_dependency 'fakefs'
   gem.add_development_dependency 'yard'
   gem.add_development_dependency 'redcarpet'
 
+
   #we need this for the dummy app
   gem.add_development_dependency 'sqlite3'
 end

data/spec/generators/roboto/install_generator_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+require 'generators/roboto/install_generator'
+
+describe Roboto::Generators::InstallGenerator do
+  destination File.expand_path("../../../dummy_generator", __FILE__)
+
+  before {prepare_destination}
+
+  describe 'presence of roboto configuration file' do
+    before do
+      @env_availabe = ["roboto_env", "staging", "production"]
+      create_fake_env
+      create_routes_rb
+      run_generator
+    end
+
+    ["roboto_env", "staging", "production"].each  do |env|
+       describe 'config/robots/#{env}.txt' do
+        subject { file("config/robots/#{env}.txt") }
+        it { should exist }
+        it { should contain "User-Agent: *" }
+        it { should contain "Disallow: /" }
+      end
+    end
+
+    describe 'config/routes.rb' do
+      subject { file('config/routes.rb') }
+      it { should exist }
+      it { should contain "mount_roboto" }
+    end
+  end
+
+  def create_routes_rb
+    routes = File.expand_path("../../../dummy/config/routes.rb", __FILE__)
+    destination = File.join(destination_root, "config")
+    FileUtils.mkdir_p(destination)
+    FileUtils.cp routes, destination
+  end
+
+  def create_fake_env
+    destination = File.join(destination_root, "config/environments")
+    FileUtils.mkdir_p(destination)
+    @env_availabe.each {|env|  FileUtils.touch(destination_root + "/config/environments/#{env}.rb")}
+  end
+end

data/spec/roboto/content_provider_spec.rb

@@ -17,8 +17,16 @@ describe Roboto::ContentProvider do
 
   it 'uses the environment specific file if found' do
     path = Rails.root.join("config/robots/test.txt")
-    FileUtils.touch(path)
+    File.open(path, 'wb') { |f| f.write(Rails.env) }
+    content_provider.path.should eql(path)
+    content_provider.contents.should eql(Rails.env)
+  end
+
+  it 'supports erb pre-processing' do
+    path = Rails.root.join("config/robots/test.txt.erb")
+    File.open(path, 'wb') { |f| f.write('<%= Rails.env %>') }
     content_provider.path.should eql(path)
+    content_provider.contents.should eql(Rails.env)
   end
 
   it 'uses the default robots file if found in the rails root' do

data/spec/spec_helper.rb

@@ -6,6 +6,7 @@ require "rails/test_help"
 
 require 'capybara/rspec'
 require 'rspec/rails'
+require 'ammeter/init'
 
 Rails.backtrace_cleaner.remove_silencers!
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: roboto
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-21 00:00:00.000000000 Z
+date: 2012-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &2156478460 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: 3.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *2156478460
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: actionpack
-  requirement: &2156471600 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *2156471600
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: rspec-rails
-  requirement: &2156470840 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +53,31 @@ dependencies:
         version: 2.9.0
   type: :development
   prerelease: false
-  version_requirements: *2156470840
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+- !ruby/object:Gem::Dependency
+  name: ammeter
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: capybara
-  requirement: &2156469740 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +85,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156469740
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: fakefs
-  requirement: &2156467660 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +101,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156467660
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &2156466460 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +117,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156466460
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: redcarpet
-  requirement: &2156456000 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +133,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156456000
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &2156454860 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,7 +149,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156454860
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A Rails Engine to help with robots.txt
 email:
 - dan.pickett@launchware.com
@@ -126,6 +182,9 @@ files:
 - bin/tmux.sh
 - config/robots/default.txt
 - config/routes.rb
+- lib/generators/roboto/install_generator.rb
+- lib/generators/templates/README
+- lib/generators/templates/robots.txt
 - lib/roboto.rb
 - lib/roboto/content_provider.rb
 - lib/roboto/engine.rb
@@ -165,11 +224,12 @@ files:
 - spec/dummy/public/500.html
 - spec/dummy/public/favicon.ico
 - spec/dummy/script/rails
+- spec/generators/roboto/install_generator_spec.rb
 - spec/requests/user_visits_robots_spec.rb
 - spec/roboto/content_provider_spec.rb
 - spec/spec_helper.rb
 - spec/support/fakefs.rb
-homepage: ''
+homepage: https://github.com/LaunchWare/roboto
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -183,7 +243,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2852200819852454992
+      hash: -3061485289554401182
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -192,10 +252,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2852200819852454992
+      hash: -3061485289554401182
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.17
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: A Rails Engine to help with robots.txt
@@ -231,6 +291,7 @@ test_files:
 - spec/dummy/public/500.html
 - spec/dummy/public/favicon.ico
 - spec/dummy/script/rails
+- spec/generators/roboto/install_generator_spec.rb
 - spec/requests/user_visits_robots_spec.rb
 - spec/roboto/content_provider_spec.rb
 - spec/spec_helper.rb