para-seo_tools 0.2.1

data/lib/para/seo_tools/skeleton.rb

@@ -0,0 +1,79 @@
+module Para
+  module SeoTools
+    module Skeleton
+      extend ActiveSupport::Autoload
+
+      autoload :Site
+      autoload :Page
+      autoload :Worker
+
+      mattr_accessor :site, :config, :enable_logging
+
+      def self.with_logging(&block)
+        self.enable_logging = true
+        block.call
+      ensure
+        self.enable_logging = false
+      end
+
+      def self.load
+        # Ensure routes are loaded to allow skeleton to call routes name helpers
+        Rails.application.reload_routes!
+        # Skeleton file path
+        skeleton_path = Rails.root.join('config', 'skeleton.rb')
+        # Load the skeleton file
+        require skeleton_path if File.exists?(skeleton_path)
+      end
+
+      def self.draw(lazy: false, &block)
+        self.config = block
+        build unless lazy
+      end
+
+      def self.build
+        return if migrating?
+        return unless ActiveRecord::Base.connection.table_exists?(Para::SeoTools::Page.table_name)
+
+        log "   * Building app skeleton pages ..."
+
+        self.site = Skeleton::Site.new
+        # Evaluate the configuration block
+        site.instance_exec(&config)
+
+        # Save all the pages to database
+        ActiveRecord::Base.transaction do
+          log "   * Saving generated pages ..."
+
+          site.pages.each do |page|
+            page.model.save!
+          end
+
+          log "   * Destroying old pages ..."
+
+          # Delete pages not in skeleton
+          destroy_deleted_pages!
+        end
+      end
+
+      def self.migrating?
+        ActiveRecord::Migrator.needs_migration?
+      end
+
+      def self.destroy_deleted_pages!
+        identifiers = site.pages.map(&:identifier)
+        pages = Para::SeoTools::Page.where.not(identifier: identifiers)
+
+        if (count = pages.count) > 0
+          log "Destroying #{ count } removed pages from Skeleton"
+          pages.destroy_all
+        end
+      end
+
+      # Log messages when you're not in rails
+      #
+      def self.log(message)
+        Rails.logger.info(message) if enable_logging || !$0.end_with?('rails')
+      end
+    end
+  end
+end

data/lib/para/seo_tools/version.rb

@@ -0,0 +1,5 @@
+module Para
+  module SeoTools
+    VERSION = "0.2.1"
+  end
+end

data/lib/para/seo_tools/view_helpers.rb

@@ -0,0 +1,9 @@
+module Para
+  module SeoTools
+    module ViewHelpers
+      def meta_tags(options = {})
+        MetaTags::Renderer.new(self, options).render
+      end
+    end
+  end
+end

data/lib/para/seo_tools.rb

@@ -0,0 +1,43 @@
+require 'sitemap'
+require 'para'
+
+require 'para/seo_tools/engine'
+
+module Para
+  module SeoTools
+    extend ActiveSupport::Autoload
+
+    autoload :Controller
+    autoload :MetaTags
+    autoload :Routes
+    autoload :Skeleton
+    autoload :Sitemap
+
+    autoload :MetaTaggable
+    autoload :MetaTaggableMacro
+    autoload :ViewHelpers
+
+    mattr_accessor :host
+    @@host = ENV['APP_DOMAIN']
+
+    mattr_accessor :title_methods
+    @@title_methods = %w(title name)
+
+    mattr_accessor :description_methods
+    @@description_methods = %w(description desc content)
+
+    mattr_accessor :image_methods
+    @@image_methods = %w(image picture avatar)
+
+    mattr_accessor :defaults
+    @@defaults = nil
+
+    def self.configure
+      block_given? ? yield(self) : self
+    end
+
+    def self.table_name_prefix
+      'seo_tools_'
+    end
+  end
+end

data/lib/tasks/migration.rake

@@ -0,0 +1,20 @@
+namespace :seo_tools do
+  task migrate_from_meta_tags: :environment do
+    ActiveRecord::Base.transaction do
+      pages = Para::SeoTools::Page.all
+
+      meta_tags = MetaTags::List.where(identifier: pages.map(&:identifier)).each_with_object({}) do |mt, hash|
+        hash[mt.identifier] = mt
+      end
+
+      print " * Migrating data for #{ pages.length } pages and #{ meta_tags.length } meta tags items ... "
+
+      pages.each do |page|
+        next unless (mt = meta_tags[page.identifier])
+        page.update(title: mt.meta_title, description: mt.meta_description, keywords: mt.meta_keywords)
+      end
+
+      puts 'done !'
+    end
+  end
+end

data/lib/tasks/sitemap.rake

@@ -0,0 +1,17 @@
+namespace :seo_tools do
+  namespace :sitemap do
+    desc "Generates a new sitemap."
+    task generate: :environment do
+      Para::SeoTools::Sitemap.build
+      root = ::Sitemap.configuration.save_path || ENV["LOCATION"] || Rails.public_path
+      path = File.join(root, "sitemap.xml")
+      ::Sitemap::Generator.instance.build!
+      ::Sitemap::Generator.instance.save(path)
+    end
+
+    desc "Ping engines."
+    task ping: :environment do
+      ::Sitemap::Ping.send_request(ENV["LOCATION"])
+    end
+  end
+end

data/lib/tasks/skeleton.rake

@@ -0,0 +1,9 @@
+namespace :seo_tools do
+  namespace :skeleton do
+    desc "Builds or refreshes the app skeleton."
+    task build: :environment do
+      Para::SeoTools::Skeleton.load
+      Para::SeoTools::Skeleton::Worker.perform
+    end
+  end
+end

data/para-seo_tools.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'para/seo_tools/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "para-seo_tools"
+  spec.version       = Para::SeoTools::VERSION
+  spec.authors       = ["Valentin Ballestrino"]
+  spec.email         = ["vala@glyph.fr"]
+  spec.summary       = %q{SEO tools for the Para CMS}
+  spec.description   = %q{SEO tools for the Para CMS}
+  spec.homepage      = "https://github.com/para-cms/para"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'rails', '>= 4.0', '< 5.0'
+  spec.add_dependency 'sitemap', '~> 0.3'
+  spec.add_dependency 'request_store'
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/test/fixtures/seo_tools/pages.yml

@@ -0,0 +1,11 @@
+# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
+
+one:
+  identifier: MyString
+  path: MyString
+  meta_tags_list_id: 
+
+two:
+  identifier: MyString
+  path: MyString
+  meta_tags_list_id: 

data/test/models/seo_tools/page_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class SeoTools::PageTest < ActiveSupport::TestCase
+  # test "the truth" do
+  #   assert true
+  # end
+end

metadata

@@ -0,0 +1,181 @@
+--- !ruby/object:Gem::Specification
+name: para-seo_tools
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Valentin Ballestrino
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: sitemap
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: request_store
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: SEO tools for the Para CMS
+email:
+- vala@glyph.fr
+executables:
+- rails
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/.DS_Store
+- app/components/seo_tools_skeleton_component.rb
+- app/controllers/.DS_Store
+- app/controllers/admin/para/seo_tools/skeleton_resources_controller.rb
+- app/decorators/seo_tools_skeleton_component_decorator.rb
+- app/helpers/para/seo_tools/admin/fields_helper.rb
+- app/models/para/seo_tools/page.rb
+- app/views/.DS_Store
+- app/views/admin/.DS_Store
+- app/views/admin/para/seo_tools/pages/_actions.html.haml
+- app/views/admin/para/seo_tools/pages/_filters.html.haml
+- app/views/admin/para/seo_tools/pages/_form.html.haml
+- app/views/admin/para/seo_tools/pages/_table.html.haml
+- app/views/admin/para/seo_tools/skeleton_resources/index.html.haml
+- bin/rails
+- config/locales/para-seo_tools.fr.yml
+- db/migrate/20150601085253_create_seo_tools_pages.rb
+- db/migrate/20160610094032_add_meta_tags_to_seo_tools_pages.rb
+- db/migrate/20160614081242_add_locale_and_remove_meta_tags_list_to_seo_tools_pages.rb
+- lib/generators/para/seo_tools/install/install_generator.rb
+- lib/generators/para/seo_tools/install/templates/initializer.rb
+- lib/generators/para/seo_tools/install/templates/skeleton.rb
+- lib/para/seo_tools.rb
+- lib/para/seo_tools/controller.rb
+- lib/para/seo_tools/engine.rb
+- lib/para/seo_tools/meta_tags.rb
+- lib/para/seo_tools/meta_tags/renderer.rb
+- lib/para/seo_tools/meta_tags/store.rb
+- lib/para/seo_tools/meta_tags/tags.rb
+- lib/para/seo_tools/meta_tags/tags/base.rb
+- lib/para/seo_tools/meta_tags/tags/description.rb
+- lib/para/seo_tools/meta_tags/tags/image.rb
+- lib/para/seo_tools/meta_tags/tags/keywords.rb
+- lib/para/seo_tools/meta_tags/tags/title.rb
+- lib/para/seo_tools/meta_tags/tags/url.rb
+- lib/para/seo_tools/meta_tags/vendors.rb
+- lib/para/seo_tools/meta_tags/vendors/base.rb
+- lib/para/seo_tools/meta_tags/vendors/open_graph.rb
+- lib/para/seo_tools/meta_tags/vendors/twitter.rb
+- lib/para/seo_tools/routes.rb
+- lib/para/seo_tools/sitemap.rb
+- lib/para/seo_tools/skeleton.rb
+- lib/para/seo_tools/skeleton/page.rb
+- lib/para/seo_tools/skeleton/site.rb
+- lib/para/seo_tools/skeleton/worker.rb
+- lib/para/seo_tools/version.rb
+- lib/para/seo_tools/view_helpers.rb
+- lib/tasks/migration.rake
+- lib/tasks/sitemap.rake
+- lib/tasks/skeleton.rake
+- para-seo_tools.gemspec
+- test/fixtures/seo_tools/pages.yml
+- test/models/seo_tools/page_test.rb
+homepage: https://github.com/para-cms/para
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: SEO tools for the Para CMS
+test_files:
+- test/fixtures/seo_tools/pages.yml
+- test/models/seo_tools/page_test.rb