metaa 0.0.3 → 0.0.11

data/README.md

@@ -1,26 +1,54 @@
 [![Build Status](https://travis-ci.org/anhkind/metaa.png)](https://travis-ci.org/anhkind/metaa)
 
-# Metaa
+# Metaa: meta tags with ease
 
 Metaa adds meta tags to your Rails application with ease.
 
-## Installation
+With Metaa, you can easily add meta tags to your current model with simple DSL, then render these tags on your views with a single method.
 
-Add this line to your application's Gemfile:
+## Generator
 
-    gem 'metaa'
+The command is simple, just add the model you want to create the meta for:
+
+```
+rails generate meta Product
+```
+
+This will generate `ProductMeta` meta class in your app/meta folder.
+
+## Meta definition
+
+After generated, the meta class will look like this:
 
-And then execute:
+```
+# app/meta/product_meta.rb
+class ProductMeta < Metaa::Meta
+  def define_meta
+    # Define meta tags of your record here. Each definition will require a hash for the meta attributes,
+    #  and each attribute can be a string, symbol or lambda/proc, for example:
+    # meta name:    "title",
+    #      content: object.title # you can access the record through 'object' variable
 
-    $ bundle
+  end
+end
+```
 
-Or install it yourself as:
+You can define meta tags multiple times and these tags will be displayed in the order you define in meta class.
 
-    $ gem install metaa
+To access to the final rendered html, just use method `meta_tags` on your instance
+
+```
+product.meta_tags
+```
+
+## Installation
+
+Add Metaa to your Gemfile:
+
+    gem 'metaa'
 
-## Usage
+And run bundle install within your app's directory.
 
-TODO: Write usage instructions here
 
 ## Contributing
 

data/lib/generators/rails/meta_generator.rb

@@ -0,0 +1,37 @@
+require "rails/generators"
+
+module Rails
+  module Generators
+    class MetaGenerator < NamedBase
+      source_root File.expand_path("../templates", __FILE__)
+      check_class_collision suffix: "Meta"
+
+      class_option :parent, type: :string, desc: "The parent class for the generated meta"
+
+      def create_meta_file
+        template 'meta.rb', File.join('app/meta', class_path, "#{file_name}_meta.rb")
+      end
+
+      hook_for :test_framework
+
+      private
+      def parent_class_name
+        options.fetch("parent") do
+          begin
+            require 'application_meta'
+            ApplicationMeta
+          rescue LoadError
+            "Metaa::Meta"
+          end
+        end
+      end
+
+      # Rails 3.0.X compatibility, stolen from https://github.com/jnunemaker/mongomapper/pull/385/files#L1R32
+      unless methods.include?(:module_namespacing)
+        def module_namespacing
+          yield if block_given?
+        end
+      end
+    end
+  end
+end

data/lib/generators/rails/templates/meta.rb

@@ -0,0 +1,15 @@
+<%- module_namespacing do -%>
+<%- if parent_class_name.present? -%>
+class <%= class_name %>Meta < <%= parent_class_name %>
+  <%- else -%>
+class <%= class_name %>
+  <%- end -%>
+  def define_meta
+    # Define meta tags of your record here. Each definition will require a hash for the meta attributes,
+    #  and each attribute can be a string, symbol or lambda/proc, for example:
+    # meta name:    "title",
+    #      content: object.title # you can access to the model through 'object' method
+
+  end
+end
+<% end -%>

data/lib/generators/rspec/meta_generator.rb

@@ -0,0 +1,9 @@
+module Rspec
+  class MetaGenerator < ::Rails::Generators::NamedBase
+    source_root File.expand_path('../templates', __FILE__)
+
+    def create_spec_file
+      template 'meta_spec.rb', File.join('spec/meta', class_path, "#{singular_name}_meta_spec.rb")
+    end
+  end
+end

data/lib/generators/rspec/templates/meta_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe <%= class_name %>Meta do
+end

data/lib/metaa.rb

@@ -3,11 +3,21 @@ require 'action_view'
 require "metaa/version"
 require 'metaa/tag'
 require 'metaa/tag_collection'
-require 'metaa/view_helper'
 require 'metaa/definition'
 require 'metaa/meta'
+require 'metaa/concern'
+require 'metaa/railtie' if defined?(Rails)
 
 module Metaa
-end
+  def self.setup_orm(base)
+    base.class_eval do
+      include Metaa::Concern
+    end
+  end
 
-ActionView::Base.send :include, Metaa::ViewHelpers
+  class UninferrableMetaError < NameError
+    def initialize(klass)
+      super("Could not infer a meta for #{klass}.")
+    end
+  end
+end

data/lib/metaa/concern.rb

@@ -0,0 +1,33 @@
+module Metaa
+  module Concern
+    extend ActiveSupport::Concern
+
+    def meta
+      @meta ||= meta_class.new(self)
+    end
+
+    def meta_tags
+      meta.html
+    end
+
+    # (see ClassMethods#meta_class)
+    def meta_class
+      self.class.meta_class
+    end
+
+    module ClassMethods
+      # Infers the meta class to be used by {Concern#meta} (e.g.
+      # `Product` maps to `ProductMeta`).
+      #
+      # @return [Class] the inferred meta class.
+      def meta_class
+        prefix = respond_to?(:model_name) ? model_name : name
+        meta_name = "#{prefix}Meta"
+        meta_name.constantize
+      rescue NameError => error
+        raise unless error.missing_name?(meta_name)
+        raise Metaa::UninferrableMetaError.new(self)
+      end
+    end
+  end
+end

data/lib/metaa/meta.rb

@@ -1,29 +1,38 @@
 module Metaa
   class Meta
-    class << self
-      def meta(attributes = {})
-        definitions << Definition.new(attributes)
-      end
+    attr_reader :object
 
-      def definitions
-        @definitions ||= []
-      end
+    def initialize(object = nil)
+      @object = object
     end
 
-    attr_reader :object
+    def meta(attributes = {})
+      definitions << Definition.new(attributes)
+    end
 
-    def initialize(object)
-      @object = object
+    def definitions
+      @definitions ||= []
     end
 
+    # lazy define meta tags then collect
     def tags
-      @tag_collection ||= TagCollection.new(
-        self.class.definitions.map do |definition|
+      @tags ||= begin
+        define_meta
+        collect_tags
+      end
+    end
+
+    def html
+      tags.map(&:html).join.html_safe
+    end
+
+    private
+    def collect_tags
+      TagCollection.new(
+        definitions.map do |definition|
           definition.attributes_for(object)
         end
-      )
-
-      @tag_collection.html
+      ).tags
     end
   end
 end

data/lib/metaa/railtie.rb

@@ -0,0 +1,28 @@
+require 'rails/railtie'
+
+module ActiveModel
+  class Railtie < Rails::Railtie
+    generators do |app|
+      app ||= Rails.application # Rails 3.0.x does not yield `app`
+
+      Rails::Generators.configure! app.config.generators
+    end
+  end
+end
+
+module Metaa
+  class Railtie < Rails::Railtie
+
+    config.after_initialize do |app|
+      app.config.paths.add 'app/meta', eager_load: true
+    end
+
+    initializer "Metaa.setup_orm" do |app|
+      [:active_record].each do |orm|
+        ActiveSupport.on_load orm do
+          Metaa.setup_orm self
+        end
+      end
+    end
+  end
+end

data/lib/metaa/version.rb

@@ -1,3 +1,3 @@
 module Metaa
-  VERSION = "0.0.3"
+  VERSION = "0.0.11"
 end

data/metaa.gemspec

@@ -8,14 +8,14 @@ Gem::Specification.new do |gem|
   gem.version       = Metaa::VERSION
   gem.authors       = ["anhkind"]
   gem.email         = ["anhkind@gmail.com"]
-  gem.description   = "Metaa adds meta tags to your Rails application with ease"
-  gem.summary       = "Meta tags with ease"
+  gem.description   = "Metaa adds meta tags to your Rails application with ease."
+  gem.summary       = "Meta tags with ease."
   gem.homepage      = "https://github.com/anhkind/metaa"
 
   gem.add_dependency 'activesupport',   '>= 3.0'
   gem.add_dependency 'actionpack',      '>= 3.0'
-  gem.add_dependency 'activemodel',      '>= 3.0'
 
+  gem.add_development_dependency 'ammeter'
   gem.add_development_dependency 'rake',          '>= 0.9.2'
   gem.add_development_dependency 'rspec',         '~> 2.12'
   gem.add_development_dependency 'rspec-mocks',   '>= 2.12.1'

data/spec/generators/meta/meta_generator_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+require 'rails'
+require 'ammeter/init'
+require 'generators/rails/meta_generator'
+
+describe Rails::Generators::MetaGenerator do
+  destination File.expand_path("../tmp", __FILE__)
+
+  before { prepare_destination }
+  after(:all) { FileUtils.rm_rf destination_root }
+
+  describe "the generated meta" do
+    subject { file("app/meta/your_model_meta.rb") }
+
+    describe "naming" do
+      before { run_generator %w(YourModel) }
+
+      it { should contain "class YourModelMeta" }
+    end
+
+    describe "define_meta method" do
+      before { run_generator %w(YourModel) }
+
+      it { should contain "def define_meta" }
+    end
+
+    describe "namespacing" do
+      subject { file("app/meta/namespace/your_model_meta.rb") }
+      before { run_generator %w(Namespace::YourModel) }
+
+      it { should contain "class Namespace::YourModelMeta" }
+    end
+
+    describe "inheritance" do
+      context "by default" do
+        before { run_generator %w(YourModel) }
+
+        it { should contain "class YourModelMeta < Metaa::Meta" }
+      end
+
+      context "with the --parent option" do
+        before { run_generator %w(YourModel --parent=FooMeta) }
+
+        it { should contain "class YourModelMeta < FooMeta" }
+      end
+
+      context "with an ApplicationMeta" do
+        before do
+          Object.any_instance.stub(:require).with("application_meta").and_return do
+            stub_const "ApplicationMeta", Class.new
+          end
+        end
+
+        before { run_generator %w(YourModel) }
+
+        it { should contain "class YourModelMeta < ApplicationMeta" }
+      end
+    end
+  end
+
+  context "with -t=rspec" do
+    describe "the generated spec" do
+      subject { file("spec/meta/your_model_meta_spec.rb") }
+
+      describe "naming" do
+        before { run_generator %w(YourModel -t=rspec) }
+
+        it { should contain "describe YourModelMeta" }
+      end
+
+      describe "namespacing" do
+        subject { file("spec/meta/namespace/your_model_meta_spec.rb") }
+        before { run_generator %w(Namespace::YourModel -t=rspec) }
+
+        it { should contain "describe Namespace::YourModelMeta" }
+      end
+    end
+  end
+end

data/spec/metaa/concern_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+module Metaa
+  describe Concern do
+    describe "meta" do
+      it "returns meta object for self" do
+        model = Model.new
+        meta = model.meta
+
+        expect(meta).to be_a ModelMeta
+        expect(meta.object).to be model
+      end
+
+      it "uses the #meta_class" do
+        model = Model.new
+        model.stub meta_class: OtherMeta
+
+        expect(model.meta).to be_an_instance_of OtherMeta
+      end
+    end
+
+    describe "#meta_tags" do
+      it "returns html meta tags for self" do
+        meta_mock = double :meta, html: "<meta content=\"a title\" name=\"title\" property=\"text\" />"
+        model     = Model.new
+        model.stub meta: meta_mock
+
+        html = model.meta_tags
+
+        expect(html).to eq "<meta content=\"a title\" name=\"title\" property=\"text\" />"
+      end
+    end
+
+    describe "#meta_class" do
+      it "delegates to .meta_class" do
+        model = Model.new
+
+        Model.should_receive(:meta_class).and_return(:some_meta)
+        expect(model.meta_class).to be :some_meta
+      end
+    end
+  end
+end

data/spec/metaa/meta_spec.rb

@@ -2,44 +2,60 @@ require 'spec_helper'
 
 module Metaa
   describe Meta do
-    describe 'class methods' do
-      describe '#meta' do
-        it 'defines a meta tag' do
-          klass = Class.new(Meta)
-          block = ->(object){ object.title }
-
-          klass.class_eval do
-            meta  name:     'title',
-                  property: :text,
-                  content:  block
+    describe '#meta' do
+      it 'defines a meta tag' do
+        klass = Class.new(Meta) do
+          def define_meta
+            meta name: 'title'
           end
+        end
 
-          expect(klass.definitions.length).to eq 1
+        meta_obj = klass.new
+        meta_obj.define_meta # trigger due to lazy load
 
-          definition = klass.definitions.first
-          expect(definition.attributes).to eq({
-            name:     'title',
-            property: :text,
-            content:   block
-          })
-        end
+        expect(meta_obj.definitions.length).to eq 1
+
+        definition = meta_obj.definitions.first
+        expect(definition.attributes).to eq({
+          name: 'title'
+        })
       end
     end
 
     describe '#tags' do
       it 'returns meta tags for an object' do
-        klass = Class.new(Meta)
-
-        klass.class_eval do
-          meta  name:     'title',
-                property: :text,
-                content:  ->(object){ object.title }
+        klass = Class.new(Meta) do
+          def define_meta
+            meta  name:     'title',
+                  property: :text,
+                  content:  object.title
+          end
         end
 
         object_mock = double title: 'a title'
         meta        = klass.new(object_mock)
 
-        expect(meta.tags).to eq "<meta content=\"a title\" name=\"title\" property=\"text\" />"
+        expect(meta.tags.length).to eq 1
+
+        tag = meta.tags.first
+        expect(tag.html).to eq "<meta content=\"a title\" name=\"title\" property=\"text\" />"
+      end
+    end
+
+    describe '#html' do
+      it 'returns the meta html tags for an object' do
+        object_mock = double title: 'a title'
+        klass = Class.new(Meta) do
+          def define_meta
+            meta  name:     'title',
+                  property: :text,
+                  content:  object.title
+          end
+        end
+
+        meta = klass.new(object_mock)
+
+        expect(meta.html).to eq "<meta content=\"a title\" name=\"title\" property=\"text\" />"
       end
     end
   end

data/spec/spec_helper.rb

@@ -1,2 +1,13 @@
 require 'bundler/setup'
-require 'metaa'
+require 'metaa'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.expect_with(:rspec) {|c| c.syntax = :expect}
+  config.order = :random
+end
+
+class Model; include Metaa::Concern; end
+class ModelMeta < Metaa::Meta; end
+
+class OtherMeta < Metaa::Meta; end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: metaa
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.11
   prerelease: 
 platform: ruby
 authors:
@@ -44,21 +44,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: activemodel
+  name: ammeter
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -123,7 +123,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.12'
-description: Metaa adds meta tags to your Rails application with ease
+description: Metaa adds meta tags to your Rails application with ease.
 email:
 - anhkind@gmail.com
 executables: []
@@ -136,19 +136,25 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- lib/generators/rails/meta_generator.rb
+- lib/generators/rails/templates/meta.rb
+- lib/generators/rspec/meta_generator.rb
+- lib/generators/rspec/templates/meta_spec.rb
 - lib/metaa.rb
+- lib/metaa/concern.rb
 - lib/metaa/definition.rb
 - lib/metaa/meta.rb
+- lib/metaa/railtie.rb
 - lib/metaa/tag.rb
 - lib/metaa/tag_collection.rb
 - lib/metaa/version.rb
-- lib/metaa/view_helper.rb
 - metaa.gemspec
+- spec/generators/meta/meta_generator_spec.rb
+- spec/metaa/concern_spec.rb
 - spec/metaa/definition_spec.rb
 - spec/metaa/meta_spec.rb
 - spec/metaa/tag_collection_spec.rb
 - spec/metaa/tag_spec.rb
-- spec/metaa/view_helper_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/anhkind/metaa
 licenses: []
@@ -173,11 +179,12 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Meta tags with ease
+summary: Meta tags with ease.
 test_files:
+- spec/generators/meta/meta_generator_spec.rb
+- spec/metaa/concern_spec.rb
 - spec/metaa/definition_spec.rb
 - spec/metaa/meta_spec.rb
 - spec/metaa/tag_collection_spec.rb
 - spec/metaa/tag_spec.rb
-- spec/metaa/view_helper_spec.rb
 - spec/spec_helper.rb

data/lib/metaa/view_helper.rb

@@ -1,16 +0,0 @@
-module Metaa
-  module ViewHelpers
-    def add_meta_tags(meta = [])
-      meta = [meta] if !meta.is_a? Array
-      self.meta_tags.concat meta
-    end
-
-    def display_meta_tags
-      TagCollection.new(meta_tags).html
-    end
-
-    def meta_tags
-      @meta_tags ||= []
-    end
-  end
-end

data/spec/metaa/view_helper_spec.rb

@@ -1,40 +0,0 @@
-require 'spec_helper'
-
-module Metaa
-  describe ViewHelpers do
-    let(:subject) { Class.new{include ViewHelpers}.new }
-
-    describe "#add_meta_tags" do
-      it "adds the meta tags from an input array" do
-        meta = [
-          { name: 'keywords', content: 'abc'}
-        ]
-
-        subject.add_meta_tags meta
-        expect(subject.send :meta_tags).to eq([
-          { name: 'keywords', content: 'abc'}
-        ])
-      end
-
-      it "adds the meta tags from an input hash" do
-        meta = { name: 'keywords', content: 'abc'}
-
-        subject.add_meta_tags meta
-        expect(subject.send :meta_tags).to eq([
-          { name: 'keywords', content: 'abc'}
-        ])
-      end
-    end
-
-    describe "#display_meta_tags" do
-      it "displays the added meta tags" do
-        subject.stub meta_tags: [
-                                  { name: 'keywords', content: 'abc'}
-                                ]
-
-        expect(subject.display_meta_tags).to eq "<meta content=\"abc\" name=\"keywords\" />"
-      end
-    end
-  end
-end
-