sitemap_boiler 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4a20e7255618af7746744e836ea449aca34e7379
+  data.tar.gz: f34c2137a0c76e66fb79a3690d1e6d59eb45bc2d
+SHA512:
+  metadata.gz: 4fd9759d152fb23e665119d10566cc3717f09967f49f9aef1f0517bfe96eac99eed86a144e9cefd977df8e415f3db836c2f6bf34c1fd50935423b6c67e8ba2f8
+  data.tar.gz: acb9349ab85d08c57b5a298a84400143ca0ee7c8e854d25c6b7aec6f35361c75d9cdd734cfac2efd7b19babeb7a9d7cc507eff9250434a22300d1ee6fd07540d

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.14.6

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'builder', '~> 3.2', '>= 3.2.2'
+gem 'json-schema'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 theocarrive
+
+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,36 @@
+# SitemapBoiler
+
+[![Build Status](https://travis-ci.org/cheerz/sitemap_boiler.svg?branch=master)](https://travis-ci.org/cheerz/sitemap_boiler)
+[![Maintainability](https://api.codeclimate.com/v1/badges/e8e9c3b8ed2629568cd6/maintainability)](https://codeclimate.com/github/cheerz/sitemap_boiler/maintainability)
+
+Welcome to SitemapBoiler! 
+
+This Gem is for websites with a limited number of URLs they want in their sitemap, to be registered in SEO results. 
+It allows you to have those URLs in a single JSON file, and to generate XML sitemaps in each language you want.
+You can eventually make it run through a Cron job, and build the JSON input file from results of your database.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sitemap_boiler'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sitemap_boiler
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/sitemap_boiler.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sitemap_boiler"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/sitemap_boiler.rb

@@ -0,0 +1,14 @@
+require 'sitemap_boiler/version'
+require 'sitemap_boiler/config'
+require 'sitemap_boiler/sitemap_generator'
+
+module SitemapBoiler
+  def self.generate(config_hash, output_dir)
+    config = SitemapBoiler::Config.new(config_hash)
+    generator = SitemapBoiler::SitemapGenerator.new(config)
+    config[:localizations].each do |localization|
+      file_suffix = localization['prefix'] || 'default'
+      generator.write(localization, "#{output_dir}/sitemap-#{file_suffix}.xml")
+    end
+  end
+end

data/lib/sitemap_boiler/config.rb

@@ -0,0 +1,27 @@
+require 'sitemap_boiler/default_config'
+require 'json'
+
+module SitemapBoiler
+  class Config
+    attr_accessor :config_hash
+
+    def initialize(config_hash)
+      @config_hash = DefaultConfig.merge(config_hash)
+    end
+
+    def [](key)
+      config_hash[key.to_s]
+    end
+
+    def self.from_file config_path
+      config_hash = JSON.parse(File.read(config_path))
+      new(config_hash)
+    end
+
+    private
+
+    def read_config(path)
+      JSON.parse File.open(path).read
+    end
+  end
+end

data/lib/sitemap_boiler/default_config.rb

@@ -0,0 +1,19 @@
+module SitemapBoiler
+  class DefaultConfig
+    def self.merge(config_hash)
+      to_h.merge(config_hash)
+    end
+
+    def self.to_h
+      {
+        'urlset_headers' => {
+          'xmlns'          => 'http://www.sitemaps.org/schemas/sitemap/0.9',
+          'xhtml'          => 'http://www.w3.org/1999/xhtml',
+          'xmlns:mobile'   => 'http://www.google.com/schemas/sitemap-mobile/1.0',
+          'xmlns:image'    => 'http://www.google.com/schemas/sitemap-image/1.1',
+          'xmlns:xhtml'    => 'http://www.w3.org/1999/xhtml'
+        }
+      }
+    end
+  end
+end

data/lib/sitemap_boiler/sitemap_generator.rb

@@ -0,0 +1,48 @@
+require 'builder'
+require 'sitemap_boiler/url_composer'
+
+module SitemapBoiler
+  class SitemapGenerator
+    attr_accessor :config
+
+    def initialize config
+      @config = config
+    end
+
+    def write localization, path
+      File.open(path, 'w') { |file| file.write(to_xml(localization)) }
+    end
+
+    def location_url config, localization, page
+      URLComposer.compose(config[:base_url], localization['prefix'], page['path'])
+    end
+
+    def to_xml localization
+      xml_markup.urlset(config[:urlset_headers]) do |urlset|
+        config[:pages].each do |page|
+          urlset.url do |url|
+            url.loc location_url(config, localization, page)
+            config[:localizations].each do |alternate|
+              url.tag!('xhtml:link', 
+                href: location_url(config, alternate, page),
+                hreflang: alternate['hreflang'],
+                rel: :alternate
+                )
+            end
+            if page['android_url']
+              url.tag!('xhtml:link', href: page['android_url'], rel: :alternate)
+            end
+          end
+        end
+      end
+    end
+
+    private
+
+    def xml_markup
+      xml = Builder::XmlMarkup.new(indent: 2)
+      xml.instruct! :xml, encoding: 'UTF-8'
+      xml
+    end
+  end
+end

data/lib/sitemap_boiler/url_composer.rb

@@ -0,0 +1,7 @@
+module SitemapBoiler
+  class URLComposer
+    def self.compose(*args)
+      args.select { |a| a && a != '' }.join('/')
+    end
+  end
+end

data/lib/sitemap_boiler/version.rb

@@ -0,0 +1,3 @@
+module SitemapBoiler
+  VERSION = "0.1.0"
+end

data/sitemap_boiler.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sitemap_boiler/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sitemap_boiler"
+  spec.version       = SitemapBoiler::VERSION
+  spec.authors       = ["Théo CARRIVE"]
+
+  spec.summary       = %q{Generate multiple languages sitemap from one config file}
+  spec.homepage      = "https://github.com/cheerz/sitemap_boiler"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "pry", "~> 0.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/test.xml

@@ -0,0 +1,41 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xhtml="http://www.w3.org/1999/xhtml" xmlns:mobile="http://www.google.com/schemas/sitemap-mobile/1.0" xmlns:image="http://www.google.com/schemas/sitemap-image/1.1" xmlns:xhtml="http://www.w3.org/1999/xhtml">
+  <url>
+    <loc>https://www.testdomain.com</loc>
+    <xhtml:link href="https://www.testdomain.com" hreflang="x-default" rel="alternate"/>
+    <xhtml:link href="https://www.testdomain.com/fr" hreflang="fr-FR" rel="alternate"/>
+    <xhtml:link href="https://www.testdomain.com/ch-fr" hreflang="fr-CH" rel="alternate"/>
+    <xhtml:link href="https://www.testdomain.com/uk" hreflang="en-GB" rel="alternate"/>
+    <xhtml:link href="https://www.testdomain.com/us" hreflang="en-US" rel="alternate"/>
+    <xhtml:link href="https://www.testdomain.com/en" hreflang="en" rel="alternate"/>
+    <xhtml:link href="android-app://package.app/app/home" rel="alternate"/>
+  </url>
+  <url>
+    <loc>https://www.testdomain.com/categories/cute-giraffe</loc>
+    <xhtml:link href="https://www.testdomain.com/categories/cute-giraffe" hreflang="x-default" rel="alternate"/>
+    <xhtml:link href="https://www.testdomain.com/fr/categories/cute-giraffe" hreflang="fr-FR" rel="alternate"/>
+    <xhtml:link href="https://www.testdomain.com/ch-fr/categories/cute-giraffe" hreflang="fr-CH" rel="alternate"/>
+    <xhtml:link href="https://www.testdomain.com/uk/categories/cute-giraffe" hreflang="en-GB" rel="alternate"/>
+    <xhtml:link href="https://www.testdomain.com/us/categories/cute-giraffe" hreflang="en-US" rel="alternate"/>
+    <xhtml:link href="https://www.testdomain.com/en/categories/cute-giraffe" hreflang="en" rel="alternate"/>
+  </url>
+  <url>
+    <loc>https://www.testdomain.com/all_categories</loc>
+    <xhtml:link href="https://www.testdomain.com/all_categories" hreflang="x-default" rel="alternate"/>
+    <xhtml:link href="https://www.testdomain.com/fr/all_categories" hreflang="fr-FR" rel="alternate"/>
+    <xhtml:link href="https://www.testdomain.com/ch-fr/all_categories" hreflang="fr-CH" rel="alternate"/>
+    <xhtml:link href="https://www.testdomain.com/uk/all_categories" hreflang="en-GB" rel="alternate"/>
+    <xhtml:link href="https://www.testdomain.com/us/all_categories" hreflang="en-US" rel="alternate"/>
+    <xhtml:link href="https://www.testdomain.com/en/all_categories" hreflang="en" rel="alternate"/>
+  </url>
+  <url>
+    <loc>https://www.testdomain.com/categories/freaky-monkey</loc>
+    <xhtml:link href="https://www.testdomain.com/categories/freaky-monkey" hreflang="x-default" rel="alternate"/>
+    <xhtml:link href="https://www.testdomain.com/fr/categories/freaky-monkey" hreflang="fr-FR" rel="alternate"/>
+    <xhtml:link href="https://www.testdomain.com/ch-fr/categories/freaky-monkey" hreflang="fr-CH" rel="alternate"/>
+    <xhtml:link href="https://www.testdomain.com/uk/categories/freaky-monkey" hreflang="en-GB" rel="alternate"/>
+    <xhtml:link href="https://www.testdomain.com/us/categories/freaky-monkey" hreflang="en-US" rel="alternate"/>
+    <xhtml:link href="https://www.testdomain.com/en/categories/freaky-monkey" hreflang="en" rel="alternate"/>
+    <xhtml:link href="android-app://package.app/app/freaky-monkey" rel="alternate"/>
+  </url>
+</urlset>

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: sitemap_boiler
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Théo CARRIVE
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-09-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sitemap_boiler.rb
+- lib/sitemap_boiler/config.rb
+- lib/sitemap_boiler/default_config.rb
+- lib/sitemap_boiler/sitemap_generator.rb
+- lib/sitemap_boiler/url_composer.rb
+- lib/sitemap_boiler/version.rb
+- sitemap_boiler.gemspec
+- test.xml
+homepage: https://github.com/cheerz/sitemap_boiler
+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.6.13
+signing_key: 
+specification_version: 4
+summary: Generate multiple languages sitemap from one config file
+test_files: []