seo_landing_pages 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 77d15341615a1eaef42e7ea13588d6837ff9da30
-  data.tar.gz: 0f38fd88a97ad81d5df5b3f4b32525686a97c1b3
+  metadata.gz: 6cec4cab3f4abdb309717bd20fc068efc9e33b9c
+  data.tar.gz: 264bea4b83ed3efe70930eff90e22ecaaabb837a
 SHA512:
-  metadata.gz: ae1473d234033c963fa61655ce458902e0e57ecad76b31492e2f643e148e9bbffcaac25148991ef99f1cd62e8b39e97add4b50a0885c3b0b9b394f81f200141e
-  data.tar.gz: 20ab9063e8686716e5d67378617abcc9a6e6996ba8ef428e1b877ee6b1f3eef4db8c883d6fc450e3ffc16069a770b966c5501cdeffe747cbd8d8f4bc8e2099d3
+  metadata.gz: f5d88d0a9d15a095145bac860aaf65b7ef98afe1a7c86bee32762b809109ffdd43a23b715d23c50db00382704be4f305619bc59698fcb256918f373dec821c91
+  data.tar.gz: 0700a977b0517f01d724561ad036092f93067b72fd839f9b0b2f7761708ad430ddffe21a47f08155d7f3931b1103127892358fa48e02b5fbaea96bcdab896b96

data/README.md

@@ -80,6 +80,25 @@ tag for you to concatenate them or so.
 = seo_landing_page_keywords
 ```
 
+### Internationalization support
+
+For internationalization, instead of writing plain text in the title, description
+and keywords write i18n keys, e.g. a landing page for your home page:
+
+    > SeoLandingPages::Model.create! slug: '/', title:       'title_home_page',
+                                                description: 'description_home_page',
+                                                keywords:    'keywords_home_page'
+
+Create the translations in your locale files. Then use the view helpers like this:
+
+```ruby
+= seo_landing_page_title_tag i18n: true
+= seo_landing_page_description_tag i18n: true
+= seo_landing_page_keywords_tag i18n: true
+```
+
+Now your pages have the HTML elements localized.
+
 ### Admin section
 
 There's an Active Admin view provided, to get it run:
@@ -93,14 +112,11 @@ traffic increasing for your website.
 
 ## TODO
 
-- write another CRUD admin section for those not using Active Admin
+- write another CRUD admin section for those not using Active Admin, or accept
+a Pull Request having it ;-)
+- fix the TODOs in the code
 - write tests
 
-## Credits
-
-This gem was developed in the [Hack Week at XING Barcelona](http://www.xing.com), Big
-thanks to XING for providing the time to see ideas being realized.
-
 ## Contributing
 
 1. Fork it ( https://github.com/joahking/seo_landing_pages/fork )
@@ -109,3 +125,8 @@ thanks to XING for providing the time to see ideas being realized.
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
 
+## Credits
+
+This gem was developed in the [Hack Week at XING Barcelona](http://www.xing.com), Big
+thanks to XING for providing the time to see ideas being realized.
+

data/lib/seo_landing_pages/helper.rb

@@ -3,47 +3,73 @@ module SeoLandingPages
   module Helper
 
     # Public: html title tag with the landing page title.
+    # - i18n: false = render plain text title. This is the default.
+    #         true  = title is an i18n key, so translate it.
     # If the landing page title is empty it returns nothing.
-    def seo_landing_page_title_tag
-      if seo_landing_page_title
-        "<title>#{ seo_landing_page_title }</title>".html_safe
+    def seo_landing_page_title_tag(i18n: false)
+      title = seo_landing_page_title i18n: i18n
+      if title
+        "<title>#{ title }</title>".html_safe
       end
     end
 
     # Public: landing page title.
-    def seo_landing_page_title
+    # - i18n: false = render plain text title. This is the default.
+    #         true  = title is an i18n key, so translate it.
+    def seo_landing_page_title(i18n: false)
       if seo_current_landing_page
-        seo_current_landing_page.title
+        title = seo_current_landing_page.title
+        if title
+          i18n ? t(title) : title
+        end
       end
     end
 
     # Public: html description meta tag with the landing page description.
+    # - i18n: false = render plain text description. This is the default.
+    #         true  = description is an i18n key, so translate it.
     # If the landing page description is empty it returns nothing.
-    def seo_landing_page_description_tag
-      if seo_landing_page_description
-        "<meta name='description' content='#{ seo_landing_page_description }'/>".html_safe
+    def seo_landing_page_description_tag(i18n: false)
+      description = seo_landing_page_description i18n: i18n
+      if description
+        "<meta name='description' content='#{ description }'/>".html_safe
       end
     end
 
     # Public: landing page description.
-    def seo_landing_page_description
+    # - i18n: false = render plain text description. This is the default.
+    #         true  = description is an i18n key, so translate it.
+    # If the landing page description is empty it returns nothing.
+    def seo_landing_page_description(i18n: false)
       if seo_current_landing_page
-        seo_current_landing_page.description
+        description = seo_current_landing_page.description
+        if description
+          i18n ? t(description) : description
+        end
       end
     end
 
     # Public: html keywords meta tag with the landing page keywords.
+    # - i18n: false = render plain text keywords. This is the default.
+    #         true  = keywords is an i18n key, so translate it.
     # If the landing page keywords is empty it returns nothing.
-    def seo_landing_page_keywords_tag
-      if seo_landing_page_keywords
-        "<meta name='keywords' content='#{ seo_landing_page_keywords }'/>".html_safe
+    def seo_landing_page_keywords_tag(i18n: false)
+      keywords = seo_landing_page_keywords i18n: i18n
+      if keywords
+        "<meta name='keywords' content='#{ keywords }'/>".html_safe
       end
     end
 
     # Public: landing page keywords.
-    def seo_landing_page_keywords
+    # - i18n: false = render plain text keywords. This is the default.
+    #         true  = keywords is an i18n key, so translate it.
+    # If the landing page keywords is empty it returns nothing.
+    def seo_landing_page_keywords(i18n: false)
       if seo_current_landing_page
-        seo_current_landing_page.keywords
+        keywords = seo_current_landing_page.keywords
+        if keywords
+          i18n ? t(keywords) : keywords
+        end
       end
     end
 

data/lib/seo_landing_pages/version.rb

@@ -1,4 +1,4 @@
 module SeoLandingPages
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end
 

data/seo_landing_pages.gemspec

@@ -11,12 +11,13 @@ Gem::Specification.new do |spec|
   spec.summary       = %q{Manage SEO key elements of landing pages in Rails easily.}
   spec.description   = %q{Create landing pages matching your pages, and manage their title, description and keywords in Rails easily.}
   spec.homepage      = 'https://github.com/joahking/seo-landing-pages'
-  spec.license       = "MIT"
+  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.required_ruby_version = '~> 2'
 
   spec.add_development_dependency 'bundler', '~> 1.6'
   spec.add_development_dependency 'rake', '~> 10'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: seo_landing_pages
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Joaquin Rivera Padron
@@ -93,9 +93,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="