zen_seo 0.0.1 → 0.0.2

data/.gitignore

@@ -0,0 +1,12 @@
+.bundle/
+.idea
+log/*.log
+pkg/
+test/dummy/db/*.sqlite3
+test/dummy/log/*.log
+test/dummy/tmp/
+test/dummy/.sass-cache
+spec/dummy/db/*.sqlite3
+spec/dummy/log/*.log
+spec/dummy/tmp/
+spec/dummy/.sass-cache

data/.gitignore~

@@ -0,0 +1,7 @@
+.bundle/
+log/*.log
+pkg/
+test/dummy/db/*.sqlite3
+test/dummy/log/*.log
+test/dummy/tmp/
+test/dummy/.sass-cache

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,22 @@
+source "http://rubygems.org"
+
+# Declare your gem's dependencies in zen_seo.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# jquery-rails is used by the dummy application
+gem "jquery-rails"
+gem 'sqlite3'
+gem 'meta-tags', :require=>'meta_tags'
+gem 'quiet_assets'
+
+gem 'rspec'
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use debugger
+# gem 'debugger'

data/Gemfile.lock

@@ -0,0 +1,115 @@
+PATH
+  remote: .
+  specs:
+    zen_seo (0.0.2)
+      meta-tags
+      rails (~> 3.2.13)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.2.13)
+      actionpack (= 3.2.13)
+      mail (~> 2.5.3)
+    actionpack (3.2.13)
+      activemodel (= 3.2.13)
+      activesupport (= 3.2.13)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.5)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.2.1)
+    activemodel (3.2.13)
+      activesupport (= 3.2.13)
+      builder (~> 3.0.0)
+    activerecord (3.2.13)
+      activemodel (= 3.2.13)
+      activesupport (= 3.2.13)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.13)
+      activemodel (= 3.2.13)
+      activesupport (= 3.2.13)
+    activesupport (3.2.13)
+      i18n (= 0.6.1)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.4)
+    diff-lcs (1.2.1)
+    erubis (2.7.0)
+    hike (1.2.1)
+    i18n (0.6.1)
+    journey (1.0.4)
+    jquery-rails (2.2.1)
+      railties (>= 3.0, < 5.0)
+      thor (>= 0.14, < 2.0)
+    json (1.7.7)
+    mail (2.5.3)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    meta-tags (1.4.1)
+      actionpack
+    mime-types (1.21)
+    multi_json (1.7.2)
+    polyglot (0.3.3)
+    quiet_assets (1.0.2)
+      railties (>= 3.1, < 5.0)
+    rack (1.4.5)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.3)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (3.2.13)
+      actionmailer (= 3.2.13)
+      actionpack (= 3.2.13)
+      activerecord (= 3.2.13)
+      activeresource (= 3.2.13)
+      activesupport (= 3.2.13)
+      bundler (~> 1.0)
+      railties (= 3.2.13)
+    railties (3.2.13)
+      actionpack (= 3.2.13)
+      activesupport (= 3.2.13)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (10.0.4)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.0)
+    sprockets (2.2.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.7)
+    thor (0.18.0)
+    tilt (1.3.6)
+    treetop (1.4.12)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.37)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jquery-rails
+  meta-tags
+  quiet_assets
+  rspec
+  sqlite3
+  zen_seo!

data/README.md

@@ -0,0 +1,88 @@
+#ZEN_SEO is a clean way of managing your meta tags for resources
+## Install
+Hope all of us are at least on Rails3 and moving to upcoming Rails4(unsupported for now)
+```sh
+    # Gemfile
+    gem 'zen_seo'
+```
+Then run the install generator, that will create migration(MongoDB is on the routemap) for the SEO model.
+```sh
+    rails generate zen_seo:install
+```
+
+## Usage
+Pick up a resource to grant a promotable behavior
+### Model
+
+```ruby
+   #app/models/post.rb
+   has_seo
+```
+
+This will try to call `title`, `description`, `keywords` on your model to fill in seo fields, optionally you can  supply a hash, that redefines the methods to be called
+
+```ruby
+   #app/models/post.rb
+   class Post < ActiveRecord::Base
+     attr_accessible :body, :tags, :title
+     has_seo :description=>:body, :keywords=>:make_keywords
+
+     private
+     def make_keywords
+       self.tags.gsub(/:/, ', ')
+     end
+   end
+```
+
+###Controller
+
+ZEN_SEO heavily based on [meta_tags](https://github.com/kpumuk/meta-tags) gem, so set it up as normal.
+
+When your layout contains
+```ruby
+    #application.html.erb
+    <head>
+      <%= display_meta_tags default_meta_tags %>
+    </head>
+```
+now in controller you can use `meta_tags_for` helper
+```ruby
+    #posts_controller.rb
+    # GET /posts/1
+    # GET /posts/1.json
+    def show
+      @post = Post.find(params[:id])
+      meta_tags_for @post
+      respond_to do |format|
+        format.html # show.html.erb
+        format.json { render json: @post }
+      end
+    end
+```
+###Form
+To set meta tags for your resource just put `fields_for :seo` in your form. Like this:
+```erb
+  <h3>Make yout post seo-friendly</h3>
+  <%= f.fields_for :seo do |seo| %>
+    <div class="field">
+      <%= seo.label :title %><br />
+      <%= seo.text_field :title %>
+    </div>
+    <div class="field">
+      <%= seo.label :keywords %><br />
+      <%= seo.text_field :keywords %>
+    </div>
+    <div class="field">
+      <%= seo.label :description %><br />
+      <%= seo.text_area :description %>
+    </div>
+  <% end %>
+```
+
+## Note on Patches/Pull Requests
+
+* Any help on issues-fighting(or finding) and testing is highly appreciated
+
+## Copyright
+
+Sergey Prikhodko originally developed by Jared Pace Copyright (c) 2010. See LICENSE for details.

data/lib/zen_seo/base.rb

@@ -6,7 +6,8 @@ module ZenSeo
     end
 
     def has_seo_config(options={})
-      @has_seo_config ||= options
+      defaults={title: :title, description: :description, keywords: :keywords}
+      @has_seo_config ||= defaults.merge options
     end
 
   end
@@ -36,9 +37,9 @@ module ZenSeo
     end
 
     def generate_seo_fields
-      seo.title ||= self.send (has_seo_config[:title] || :title)
-      seo.description ||= self.send (has_seo_config[:description] || :description)
-      seo.keywords ||= self.send (has_seo_config[:keywords] || :keywords)
+      seo.title=        self.send (has_seo_config[:title])        if seo.title.blank?
+      seo.description=  self.send (has_seo_config[:description])  if seo.description.blank?
+      seo.keywords=     self.send (has_seo_config[:keywords])     if seo.keywords.blank?
     end
 
   end

data/lib/zen_seo/controller_helper.rb

@@ -10,6 +10,7 @@ module ZenSeo
                       :description=>model.seo.description,
                       :keywords=>model.seo.keywords
       end
+      alias :meta_for :meta_tags_for
       protected :meta_tags_for
     end
   end

data/lib/zen_seo/version.rb

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

data/spec/dummy/app/assets/javascripts/posts.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/spec/dummy/app/assets/stylesheets/posts.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/spec/dummy/app/assets/stylesheets/scaffold.css

@@ -0,0 +1,56 @@
+body { background-color: #fff; color: #333; }
+
+body, p, ol, ul, td {
+  font-family: verdana, arial, helvetica, sans-serif;
+  font-size:   13px;
+  line-height: 18px;
+}
+
+pre {
+  background-color: #eee;
+  padding: 10px;
+  font-size: 11px;
+}
+
+a { color: #000; }
+a:visited { color: #666; }
+a:hover { color: #fff; background-color:#000; }
+
+div.field, div.actions {
+  margin-bottom: 10px;
+}
+
+#notice {
+  color: green;
+}
+
+.field_with_errors {
+  padding: 2px;
+  background-color: red;
+  display: table;
+}
+
+#error_explanation {
+  width: 450px;
+  border: 2px solid red;
+  padding: 7px;
+  padding-bottom: 0;
+  margin-bottom: 20px;
+  background-color: #f0f0f0;
+}
+
+#error_explanation h2 {
+  text-align: left;
+  font-weight: bold;
+  padding: 5px 5px 5px 15px;
+  font-size: 12px;
+  margin: -7px;
+  margin-bottom: 0px;
+  background-color: #c00;
+  color: #fff;
+}
+
+#error_explanation ul li {
+  font-size: 12px;
+  list-style: square;
+}

data/spec/dummy/app/controllers/posts_controller.rb

@@ -0,0 +1,83 @@
+class PostsController < ApplicationController
+  # GET /posts
+  # GET /posts.json
+  def index
+    @posts = Post.all
+
+    respond_to do |format|
+      format.html # index.html.erb
+      format.json { render json: @posts }
+    end
+  end
+
+  # GET /posts/1
+  # GET /posts/1.json
+  def show
+    @post = Post.find(params[:id])
+    meta_tags_for @post
+    respond_to do |format|
+      format.html # show.html.erb
+      format.json { render json: @post }
+    end
+  end
+
+  # GET /posts/new
+  # GET /posts/new.json
+  def new
+    @post = Post.new
+
+    respond_to do |format|
+      format.html # new.html.erb
+      format.json { render json: @post }
+    end
+  end
+
+  # GET /posts/1/edit
+  def edit
+    @post = Post.find(params[:id])
+  end
+
+  # POST /posts
+  # POST /posts.json
+  def create
+    @post = Post.new(params[:post])
+
+    respond_to do |format|
+      if @post.save
+        format.html { redirect_to @post, notice: 'Post was successfully created.' }
+        format.json { render json: @post, status: :created, location: @post }
+      else
+        format.html { render action: "new" }
+        format.json { render json: @post.errors, status: :unprocessable_entity }
+      end
+    end
+  end
+
+  # PUT /posts/1
+  # PUT /posts/1.json
+  def update
+    @post = Post.find(params[:id])
+
+    respond_to do |format|
+      if @post.update_attributes(params[:post])
+        format.html { redirect_to @post, notice: 'Post was successfully updated.' }
+        format.json { head :no_content }
+      else
+        format.html { render action: "edit" }
+        format.json { render json: @post.errors, status: :unprocessable_entity }
+      end
+    end
+  end
+
+  # DELETE /posts/1
+  # DELETE /posts/1.json
+  def destroy
+    @post = Post.find(params[:id])
+    @post.destroy
+
+    respond_to do |format|
+      format.html { redirect_to posts_url }
+      format.json { head :no_content }
+    end
+  end
+end

data/spec/dummy/app/helpers/posts_helper.rb

@@ -0,0 +1,2 @@
+module PostsHelper
+end

data/spec/dummy/app/models/post.rb

@@ -0,0 +1,8 @@
+class Post < ActiveRecord::Base
+  attr_accessible :body, :tags, :title
+  has_seo :description=>:body, :keywords=>:make_keywords
+  private
+  def make_keywords
+    self.tags.gsub(/:/, ', ')
+  end
+end

data/{test → spec}/dummy/app/views/layouts/application.html.erb

@@ -2,6 +2,7 @@
 <html>
 <head>
   <title>Dummy</title>
+  <%= display_meta_tags %>
   <%= stylesheet_link_tag    "application", :media => "all" %>
   <%= javascript_include_tag "application" %>
   <%= csrf_meta_tags %>

data/spec/dummy/app/views/posts/_form.html.erb

@@ -0,0 +1,43 @@
+<%= form_for(@post) do |f| %>
+  <% if @post.errors.any? %>
+    <div id="error_explanation">
+      <h2><%= pluralize(@post.errors.count, "error") %> prohibited this post from being saved:</h2>
+
+      <ul>
+      <% @post.errors.full_messages.each do |msg| %>
+        <li><%= msg %></li>
+      <% end %>
+      </ul>
+    </div>
+  <% end %>
+  <div class="field">
+    <%= f.label :title %><br />
+    <%= f.text_field :title %>
+  </div>
+  <div class="field">
+    <%= f.label :body %><br />
+    <%= f.text_area :body %>
+  </div>
+  <div class="field">
+    <%= f.label :tags %><br />
+    <%= f.text_area :tags %>
+  </div>
+  <h3>Make yout post seo-friendly</h3>
+  <%= f.fields_for :seo do |seo| %>
+    <div class="field">
+      <%= seo.label :title %><br />
+      <%= seo.text_field :title %>
+    </div>
+    <div class="field">
+      <%= seo.label :keywords %><br />
+      <%= seo.text_field :keywords %>
+    </div>
+    <div class="field">
+      <%= seo.label :description %><br />
+      <%= seo.text_area :description %>
+    </div>
+  <% end %>
+  <div class="actions">
+    <%= f.submit %>
+  </div>
+<% end %>

data/spec/dummy/app/views/posts/edit.html.erb

@@ -0,0 +1,6 @@
+<h1>Editing post</h1>
+
+<%= render 'form' %>
+
+<%= link_to 'Show', @post %> |
+<%= link_to 'Back', posts_path %>

data/spec/dummy/app/views/posts/index.html.erb

@@ -0,0 +1,27 @@
+<h1>Listing posts</h1>
+
+<table>
+  <tr>
+    <th>Title</th>
+    <th>Body</th>
+    <th>Tags</th>
+    <th></th>
+    <th></th>
+    <th></th>
+  </tr>
+
+<% @posts.each do |post| %>
+  <tr>
+    <td><%= post.title %></td>
+    <td><%= post.body %></td>
+    <td><%= post.tags %></td>
+    <td><%= link_to 'Show', post %></td>
+    <td><%= link_to 'Edit', edit_post_path(post) %></td>
+    <td><%= link_to 'Destroy', post, method: :delete, data: { confirm: 'Are you sure?' } %></td>
+  </tr>
+<% end %>
+</table>
+
+<br />
+
+<%= link_to 'New Post', new_post_path %>

data/spec/dummy/app/views/posts/new.html.erb

@@ -0,0 +1,5 @@
+<h1>New post</h1>
+
+<%= render 'form' %>
+
+<%= link_to 'Back', posts_path %>

data/spec/dummy/app/views/posts/show.html.erb

@@ -0,0 +1,20 @@
+<p id="notice"><%= notice %></p>
+
+<p>
+  <b>Title:</b>
+  <%= @post.title %>
+</p>
+
+<p>
+  <b>Body:</b>
+  <%= @post.body %>
+</p>
+
+<p>
+  <b>Tags:</b>
+  <%= @post.tags %>
+</p>
+
+
+<%= link_to 'Edit', edit_post_path(@post) %> |
+<%= link_to 'Back', posts_path %>

data/{test → spec}/dummy/config/routes.rb

@@ -1,4 +1,8 @@
 Dummy::Application.routes.draw do
+  root to: 'posts#index'
+  resources :posts
+
+
   # The priority is based upon order of creation:
   # first created -> highest priority.
 

data/spec/dummy/db/migrate/20130329073248_create_posts.rb

@@ -0,0 +1,11 @@
+class CreatePosts < ActiveRecord::Migration
+  def change
+    create_table :posts do |t|
+      t.string :title
+      t.text :body
+      t.text :tags
+
+      t.timestamps
+    end
+  end
+end

data/spec/dummy/db/migrate/20130329073304_create_seos.rb

@@ -0,0 +1,12 @@
+class CreateSeos < ActiveRecord::Migration
+  def change
+    create_table :seos do |t|
+      t.string :title
+      t.text :description
+      t.text :keywords
+      t.references :promotable, :polymorphic=>true
+
+      t.timestamps
+    end
+  end
+end