seo_meta 1.0.0 → 1.0.1

data/license.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2011 [Philip Arndt](http://philiparndt.name)
+
+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.md

@@ -0,0 +1,99 @@
+# SEO Meta tags plugin
+
+## Installation
+
+Add to your project using your Bundler Gemfile:
+
+    gem 'seo_meta'
+
+Include in your model by calling the method `is_seo_meta` in the class declaration,
+for example with `Page`:
+
+    class Page < ActiveRecord::Base
+      is_seo_meta
+    end
+
+Run the generator:
+
+    rails generate seo_meta
+
+Migrate the database (unless you want to read 'Migrating existing data' below first):
+
+    rake db:migrate
+
+## Migrating existing data
+
+This step is only if you already implemented SEO meta tag fields in your model.
+
+At this point you could add to the migration that is generated in `db/migrate/`
+logic to migrate across your existing data and remove the columns from your model
+afterward, for example with `Page`:
+
+    class CreateSeoMeta < ActiveRecord::Migration
+
+      def self.up
+        # ... migration logic from the seo_meta generator ...
+
+        # Grab the attributes of the records that currently exist
+        existing_pages = ::Page.all.map(&:attributes)
+
+        # Remove columns
+        ::SeoMeta.attributes.each do |field|
+          if ::Page.column_names.map(&:to_sym).include?(field)
+            remove_column ::Page.table_name, field
+          end
+        end
+
+        # Reset column information because otherwise the old columns will still exist.
+        ::Page.reset_column_information
+
+        # Re-attach seo_meta
+        ::Page.module_eval do
+          is_seo_meta
+        end
+
+        # Migrate data
+        existing_pages.each do |page|
+          ::Page.find(page['id']).update_attributes({
+            ::SeoMeta.attributes.keys.inject({}) {|attributes, name|
+              attributes.merge(name => translation[name.to_s])
+            }
+          })
+        end
+      end
+
+      def self.down
+        # Grab the attributes of the records that currently exist
+        existing_pages = ::Page.all.map(&:attributes)
+
+        # Add columns back to your model
+        ::SeoMeta.attributes.each do |field, field_type|
+          unless ::Page.column_names.map(&:to_sym).include?(field)
+            add_column ::Page.table_name, field, field_type
+          end
+        end
+
+        # Reset column information because otherwise the new columns won't exist yet.
+        ::Page.reset_column_information
+
+        # Migrate data
+        existing_pages.each do |page|
+          ::Page.find(page['id']).update_attributes({
+            ::SeoMeta.attributes.keys.inject({}) {|attributes, name|
+              attributes.merge(name => translation[name.to_s])
+            }
+          })
+        end
+
+        # ... migration logic from the seo_meta generator ...
+      end
+
+    end
+
+Now, run:
+
+    rake db:migrate
+
+## Anything else?
+
+Nope, all done!

metadata

@@ -2,7 +2,7 @@
 name: seo_meta
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors: 
 - Philip Arndt
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-29 00:00:00 +13:00
+date: 2011-03-30 00:00:00 +13:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -40,6 +40,8 @@ files:
 - lib/tasks/seo_meta.rake
 - db/migrate/1_create_seo_meta.rb
 - app/models/seo_metum.rb
+- license.md
+- readme.md
 has_rdoc: true
 homepage: http://philiparndt.name
 licenses: []