RubyGems - seo_optimizer - Versions diffs - 0.1.0 → 0.1.1 - Mend

seo_optimizer 0.1.0 → 0.1.1

Files changed (10) hide show

checksums.yaml CHANGED

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 415bd41bed30c7e261ee469383cc1384e07fe41bcd1ac7e0da7b08811e3875ac
-  data.tar.gz: d45bd5f93a75a9ba0758372c3d5cb26c1fd01be470097d494f614efe2e654163
+  metadata.gz: 4d77de0d5df420769f467e81c12eca1e6bc814eae796de10f506376b96d738b6
+  data.tar.gz: 40a42a9ef40f670f7fb2d25e35f5c7dea28ff3e855e8a37856f80dd1c94a222e
 SHA512:
-  metadata.gz: e3ffb4b684021306c18991d6c35d6f024001f84f6f0b4225bf60b5fe91fcc6047c0ed168ae72ef229664ebf6c96bf9f5cb1bcd7a23eb2243ef93daf20e7fc986
-  data.tar.gz: bea7e285cdf9c260b748867a27ee1c104107543fe7892f9ff34ebe6b74fd38c78aa29f8302d198e26f54b9c9f3ba6c1d758f92c23a7cd1ee3d49e33f89c74dcd
+  metadata.gz: b7c77c623bbe62d352e4e6e87998b7d596ecfbaedb75fca0b7ee07ccb394e5831da6db6089667417b225ad5c018ffd4d3a5f8600985f4a4f4362b70454347ab2
+  data.tar.gz: 78b8152930779f80e6b734d170823a614d6ef7c65a27d0c488a06453ecd4dd6e4067bb0e5af33fd99980418a1ddfab995e3e79d7a02786e9f868a2a2be1b4fed

data/README.md CHANGED

@@ -20,6 +20,28 @@ Or install it yourself as:
 ## Usage
+#### Global generator
+This command will add setup files of errors pages, sitemap.xml, robots.txt and meta tags.
+```bash
+$ rails g seo_optimizer:fast_config
+```
+______________
+#### Meta tags
+There is a generator to setup meta tags
+```bash
+$ rails g seo_optimizer:meta_tags
+```
+This will generate meta tags config that you can customize in `config/meta.yml` and `app/views/layouts/application.html.erb`
+______________
 #### Sitemap.yml, robots.txt
 There is a generator and a task to create needed files that will be read by search engines robots.
@@ -57,6 +79,26 @@ Then you can check these urls:
 robots.txt file: http://localhost:3000/robots.txt
 sitemap.xml file: http://localhost:3000/sitemap.xml
+______________
+#### Error pages (404, 500):
+**1** - Generate error pages view, actions and routes.
+```bash
+$ rails g seo_optimizer:errors_pages
+```
+**2** - You can customize pages in `app/views/errors/`
+**3** - Edit `config/environment/develoment.rb` if you want to test it in dev environment.
+⛔️ DO NOT COMMIT ⛔️
+```ruby
+config.consider_all_requests_local = true
+# to
+config.consider_all_requests_local = false
+```
 _________________
 #### Model routes with slug:
@@ -124,26 +166,6 @@ end
 - Then don't forget to `$ rails sitemap:generate`.
-______________
-#### Error pages (404, 500):
-**1** - Generate error pages view, actions and routes.
-```bash
-$ rails g seo_optimizer:errors_pages
-```
-**2** - You can customize pages in `app/views/errors/`
-**3** - Edit `config/environment/develoment.rb` if you want to test it in dev environment.
-⛔️ DO NOT COMMIT ⛔️
-```ruby
-config.consider_all_requests_local = true
-# to
-config.consider_all_requests_local = false
-```
 _________________
 ## Development

data/lib/generators/seo_optimizer/fast_config/fast_config_generator.rb ADDED

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+require 'rails/generators/migration'
+module SeoOptimizer
+  class FastConfigGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+    desc 'Generates base setup file'
+    def add_meta_tags
+      generate 'seo_optimizer:meta_tags'
+      generate 'seo_optimizer:error_pages'
+      generate 'seo_optimizer:setups'
+      generate 'seo_optimizer:robots_files'
+      rake 'sitemap:generate'
+    end
+  end
+end

data/lib/generators/seo_optimizer/meta_tags/meta_tags_generator.rb ADDED

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+require 'rails/generators/migration'
+module SeoOptimizer
+  class MetaTagsGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+    desc 'Generates meta tags'
+    def add_meta_tags
+      inject_into_file 'app/views/layouts/application.html.erb', after: '<head>' do
+        File.open("#{File.expand_path('templates', __dir__)}/meta_tags.erb").read
+      end
+      template 'meta_tags_helper.erb', File.join('app/helpers', 'meta_tags_helper.rb')
+      template 'default_meta.erb', File.join('config/initializers', 'default_meta.rb')
+      template 'meta_yml.erb', File.join('config', 'meta.yml')
+    end
+  end
+end

data/lib/generators/seo_optimizer/meta_tags/templates/default_meta.erb ADDED

	@@ -0,0 +1 @@
1	+ DEFAULT_META = YAML.load_file(Rails.root.join("config/meta.yml"))

data/lib/generators/seo_optimizer/meta_tags/templates/meta_tags.erb ADDED

@@ -0,0 +1,19 @@
+    <title><%= meta_title %></title>
+    <meta name="description" content="<%= meta_description %>">
+    <!-- Facebook Open Graph data -->
+    <meta property="og:title" content="<%= meta_title %>" />
+    <meta property="og:type" content="website" />
+    <meta property="og:url" content="<%= request.original_url %>" />
+    <meta property="og:image" content="<%= meta_image %>" />
+    <meta property="og:description" content="<%= meta_description %>" />
+    <meta property="og:site_name" content="<%= meta_title %>" />
+    <!-- Twitter Card data -->
+    <meta name="twitter:card" content="summary_large_image">
+    <meta name="twitter:site" content="<%= DEFAULT_META["twitter_account"] %>">
+    <meta name="twitter:title" content="<%= meta_title %>">
+    <meta name="twitter:description" content="<%= meta_description %>">
+    <meta name="twitter:creator" content="<%= DEFAULT_META["twitter_account"] %>">
+    <meta name="twitter:image:src" content="<%= meta_image %>">

data/lib/generators/seo_optimizer/meta_tags/templates/meta_tags_helper.erb ADDED

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+module MetaTagsHelper
+  def meta_title
+    content_for?(:meta_title) ? content_for(:meta_title) : DEFAULT_META["meta_title"]
+  end
+  def meta_description
+    content_for?(:meta_description) ? content_for(:meta_description) : DEFAULT_META["meta_description"]
+  end
+  def meta_image
+    meta_image = (content_for?(:meta_image) ? content_for(:meta_image) : DEFAULT_META["meta_image"])
+    # little twist to make it work equally with an asset or a url
+    meta_image.starts_with?("http") ? meta_image : image_url(meta_image)
+  end
+end

data/lib/generators/seo_optimizer/meta_tags/templates/meta_yml.erb ADDED

@@ -0,0 +1,5 @@
+meta_product_name: "Product Name"
+meta_title: "Product name - Product tagline"
+meta_description: "Relevant description"
+meta_image: "cover.png" # should exist in `app/assets/images/`
+twitter_account: "@product_twitter_account"   # required for Twitter Cards

data/lib/seo_optimizer/version.rb CHANGED

@@ -1,3 +1,3 @@
 module SeoOptimizer
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata CHANGED

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: seo_optimizer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Ronan Louarn
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-01 00:00:00.000000000 Z
+date: 2020-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sitemap_generator
@@ -47,6 +47,12 @@ files:
 - lib/generators/seo_optimizer/errors_pages/templates/404.erb
 - lib/generators/seo_optimizer/errors_pages/templates/500.erb
 - lib/generators/seo_optimizer/errors_pages/templates/errors_controller_template.erb
+- lib/generators/seo_optimizer/fast_config/fast_config_generator.rb
+- lib/generators/seo_optimizer/meta_tags/meta_tags_generator.rb
+- lib/generators/seo_optimizer/meta_tags/templates/default_meta.erb
+- lib/generators/seo_optimizer/meta_tags/templates/meta_tags.erb
+- lib/generators/seo_optimizer/meta_tags/templates/meta_tags_helper.erb
+- lib/generators/seo_optimizer/meta_tags/templates/meta_yml.erb
 - lib/generators/seo_optimizer/models/models_generator.rb
 - lib/generators/seo_optimizer/models/templates/model_template.erb
 - lib/generators/seo_optimizer/robots_files/robots_files_generator.rb