noindex 0.0.1 → 0.0.2

data/.yardopts

@@ -0,0 +1,8 @@
+--markup markdown
+--markup-provider redcarpet
+--charset utf-8
+--readme README.md
+-
+README.md
+LICENSE
+

data/README.md

@@ -1,6 +1,7 @@
 # Noindex
 
-TODO: Write a gem description
+Noindex provides a simple way for Ruby on Rails applications to tell search engines what to index on your site and what to not.
+It inserts `<meta name="robots" content="noindex">` at necessary pages.
 
 ## Installation
 
@@ -18,7 +19,43 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### In your layout
+
+Add `noindex_meta_tag` helper to the `head` element of your layout. HAML example:
+
+```haml
+html
+  head
+    = noindex_meta_tag
+```
+
+It will generate following *meta_tag* element (for *new* and *edit* actions by default):
+
+```html
+<meta content="noindex" name="robots" />
+```
+
+### In your controllers
+
+*Noindex* simply adds a method `noindex` to controllers. This method is just a *before_filter* so it receives same options as a Rails *before_filter* method.
+
+By default *Noindex* filters *new* and *edit* actions. You can customise this by calling `noindex` in any controller. For example to hide only *index* and *edit* actions in *UsersController* from search engines your can do:
+
+```ruby
+class UsersController < InheritedResources::Base
+  noindex only: [ :index, :edit ]
+  ...
+end
+```
+
+If you want some actions to be searchable you can call `skip_noindex` method (that is just a *skip_before_filter* alias).
+
+```ruby
+class UsersController < InheritedResources::Base
+  skip_noindex only: [ :new ]
+  ...
+end
+```
 
 ## Contributing
 

data/lib/noindex/version.rb

@@ -1,3 +1,3 @@
 module Noindex
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/noindex.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = Noindex::VERSION
   spec.authors       = ["Michael Khabarov"]
   spec.email         = ["michaelkhabarov@alphastate.ru"]
-  spec.description   = %q{Hide some pages from search engines indexing for Ruby on Rails applications}
-  spec.summary       = %q{Noindex provides a simple way for Ruby on Rails applications to tell search engines what to index on your site and what to not.}
+  spec.description   = %q{Hide some pages from search engines in Ruby on Rails applications}
+  spec.summary       = %q{Noindex provides a simple way for Ruby on Rails applications to tell search engines what to index on your site and what to not}
   spec.homepage      = "https://github.com/michaelkhabarov/noindex"
   spec.license       = "MIT"
 
@@ -20,6 +20,8 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "redcarpet"
+  spec.add_development_dependency "yard"
 
   spec.add_dependency "rails", ">= 3.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: noindex
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-17 00:00:00.000000000 Z
+date: 2013-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -43,6 +43,38 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  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: yard
+  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: rails
   requirement: !ruby/object:Gem::Requirement
@@ -59,7 +91,7 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 3.0.0
-description: Hide some pages from search engines indexing for Ruby on Rails applications
+description: Hide some pages from search engines in Ruby on Rails applications
 email:
 - michaelkhabarov@alphastate.ru
 executables: []
@@ -67,8 +99,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .yardopts
 - Gemfile
-- LICENSE.txt
+- LICENSE
 - README.md
 - Rakefile
 - lib/noindex.rb
@@ -90,17 +123,24 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -3970455516708246295
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -3970455516708246295
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Noindex provides a simple way for Ruby on Rails applications to tell search
-  engines what to index on your site and what to not.
+  engines what to index on your site and what to not
 test_files: []
+has_rdoc: