simple_sitemap 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in simple_sitemap.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 ryanlower
+
+MIT License
+
+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,63 @@
+# SimpleSitemap
+
+A simple sitemap generator
+
+## Basic Usage
+
+### Configure
+
+```ruby
+SimpleSitemap.configure do |config|
+  config.local_path = 'tmp/'
+  config.default_path = 'http://yoursite.com'
+  config.sitemap_location = 'http://yoursite.com/sitemap'
+end
+```
+
+### Build your sitemap
+
+```ruby
+SimpleSitemap.build do
+  add_path 'home'
+  add_path 'about'
+  sitemap 'ryan' do
+    6.times do |i|
+      add_url i, priority: 0.5
+    end
+  end
+  sitemap 'lower' do
+    5.times do |i|
+      add_url i
+    end
+  end
+  sitemap 'ryan' do
+    6.times do |i|
+      add_path i, priority: 1.0
+    end
+  end
+  add_url 'http://signup.yoursite.com'
+  add_path 'login'
+end
+```
+
+## Hooks
+
+SimpleSitemap gives you a after_write hook for easy access to sitemap files as they are written.
+
+For example, to upload sitmaps to S3
+
+```ruby
+SimpleSitemap.after_write do |filename|
+  s3 = Fog::Storage.new({
+    provider: 'AWS',
+    aws_access_key_id: 'YOUR_AWS_KEY',
+    aws_secret_access_key: 'YOUR_AWS_SECRET'
+  })
+  bucket = s3.directories.first
+  bucket.files.create(
+    :key => File.basename(filename),
+    :body => open(filename),
+    :public => true
+  )
+end
+```

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/simple_sitemap.rb

@@ -0,0 +1,41 @@
+
+require 'simple_sitemap/generators/base'
+require 'simple_sitemap/generators/index'
+require 'simple_sitemap/generators/sitemap'
+require 'simple_sitemap/writers/gzip_writer'
+require 'simple_sitemap/writers/plain_writer'
+
+require 'simple_sitemap/version'
+
+
+module SimpleSitemap
+
+  MAX_LINKS_PER_FILE = 50000
+  MAX_FILE_SIZE = 10*1024*1024 # 10 megabytes
+
+  class << self
+
+    attr_accessor :config, :hooks
+
+    def configure(&block)
+      @config = OpenStruct.new
+      @config.gzip = true
+      @config.verbose = false
+      yield @config
+    end
+
+    def build(opts={}, &block)
+      start_time = Time.now
+      generator = Generators::Sitemap.new @config, @hooks
+      generator.instance_eval &block
+      generator.write!
+      puts "Time taken: #{Time.now - start_time}" if @config.verbose
+    end
+
+    def after_write(&block)
+      @hooks ||= {}
+      @hooks[:after_write] = block
+    end
+  end
+
+end

data/lib/simple_sitemap/generators/base.rb

@@ -0,0 +1,39 @@
+
+require 'nokogiri'
+
+module SimpleSitemap
+
+  module Generators
+
+    class Base
+
+      attr_writer :config, :hooks
+
+      def initialize(config, hooks)
+        @config = config
+        @hooks = hooks
+      end
+
+      private
+
+      def write_file(filename, xml)
+        path = File.expand_path filename, @config.local_path
+        if @config.gzip
+          Writers::GzipWriter.new.write path, xml
+        else
+          Writers::PlainWriter.new.write path, xml
+        end
+        call_hooks path if @hooks
+      end
+
+      def call_hooks(path)
+        if @hooks[:after_write]
+          @hooks[:after_write].call path
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/simple_sitemap/generators/index.rb

@@ -0,0 +1,52 @@
+
+require 'nokogiri'
+
+module SimpleSitemap
+
+  module Generators
+
+    class Index < Base
+
+      attr_accessor :sitemaps
+
+      def initialize(config, hooks)
+        super
+        @sitemaps = []
+      end
+
+      def add_sitemap(name)
+        url = if @config.sitemap_location[-1,1] == '/'
+          "#{@config.sitemap_location}#{name}"
+        else
+          "#{@config.sitemap_location}/#{name}"
+        end
+        @sitemaps << url
+      end
+
+      def write!
+        xml = to_xml
+        index_filename = 'index.xml'
+        if @config.gzip
+          index_filename << '.gz'
+        end
+        write_file index_filename, xml
+      end
+
+      def to_xml
+        builder = Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |xml|
+          xml.sitemapindex(xmlns: 'http://www.sitemaps.org/schemas/sitemap/0.9') do
+            @sitemaps.each do |sitemap_url|
+              xml.sitemap do
+                xml.loc sitemap_url
+              end
+            end
+          end
+        end
+        builder.to_xml
+      end
+
+    end
+
+  end
+
+end

data/lib/simple_sitemap/generators/sitemap.rb

@@ -0,0 +1,134 @@
+
+require 'nokogiri'
+
+module SimpleSitemap
+
+  module Generators
+
+    class Sitemap < Base
+
+      attr_accessor :sitemap_name, :sitemap_data
+
+      def initialize(config, hooks)
+        super
+        @sitemap_data = {}
+        enter_sitemap nil
+      end
+
+      def add_url(url, opts={})
+        link = { url: url }
+        link.merge! opts
+        @sitemap_data[@sitemap_name][:links] << link
+        @sitemap_data[@sitemap_name][:size] += 1
+        ## TODO, add correct bytesize (this is an overestimate)
+        @sitemap_data[@sitemap_name][:bytesize] += 200
+        if @sitemap_data[@sitemap_name][:size] >= SimpleSitemap::MAX_LINKS_PER_FILE
+          write @sitemap_name
+        end
+        if @sitemap_data[@sitemap_name][:bytesize] >= SimpleSitemap::MAX_FILE_SIZE
+          write @sitemap_name
+        end
+      end
+
+      def add_path(path, opts={})
+        if @config.default_path
+          if @config.default_path[-1,1] != '/' && path[0] != '/'
+            path = "/#{path}"
+          end
+          add_url "#{@config.default_path}#{path}", opts
+        else
+          raise "Can't add a path without configuring default_path"
+        end
+      end
+
+      def sitemap(name, &block)
+        enter_sitemap name
+        yield
+        exit_sitemap
+      end
+
+      def write!
+        @sitemap_data.keys.each do |name|
+          if @sitemap_data[name][:links].size > 0
+            write name
+          end
+        end
+        write_index
+      end
+
+      private
+
+      def enter_sitemap(name)
+        unless @sitemap_data.has_key? name
+          @sitemap_data[name] = { index: 1 }
+          reset_sitemap_data name
+        end
+        @sitemap_name = name
+      end
+
+      def exit_sitemap
+        @sitemap_name = nil
+      end
+
+      def write_index
+        index = Generators::Index.new @config, @hooks
+        @sitemap_data.keys.each do |name|
+          (1...sitemap_data[name][:index]).each do |i|
+            index.add_sitemap sitemap_filename(name, i)
+          end
+        end
+        index.write!
+      end
+
+      def write(name)
+        puts "Writing sitemap #{name}#{@sitemap_data[name][:index]}\t [#{@sitemap_data[name][:size]} urls]" if @config.verbose
+        xml = to_xml name
+        write_file sitemap_filename(name), xml
+        reset_sitemap_data name
+        @sitemap_data[name][:index] += 1
+        enter_sitemap name
+      end
+
+      def reset_sitemap_data(name)
+        default_sitemap_data = {
+          links: [],
+          size: 0,
+          bytesize: 110
+        }
+        @sitemap_data[name].merge! default_sitemap_data
+      end
+
+      def sitemap_filename(name, index=nil)
+        index ||= @sitemap_data[name][:index]
+        filename = if name
+          "#{name}_#{index}.xml"
+        else
+          "sitemap_#{index}.xml"
+        end
+        if @config.gzip
+          filename << '.gz'
+        end
+        filename
+      end
+
+      def to_xml(name)
+        builder = Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |xml|
+          xml.urlset(xmlns: 'http://www.sitemaps.org/schemas/sitemap/0.9') do
+            @sitemap_data[name][:links].each do |url|
+              xml.url do
+                xml.loc url[:url]
+                # xml.lastmod url[:lastmod].utc if url[:lastmod]
+                xml.changefreq url[:changefreq] if url[:changefreq]
+                xml.priority url[:priority] if url[:priority]
+              end
+            end
+          end
+        end
+        builder.to_xml
+      end
+
+    end
+
+  end
+
+end

data/lib/simple_sitemap/version.rb

@@ -0,0 +1,3 @@
+module SimpleSitemap
+  VERSION = '0.1.0'
+end

data/lib/simple_sitemap/writers/gzip_writer.rb

@@ -0,0 +1,18 @@
+
+module SimpleSitemap
+
+  module Writers
+
+    class GzipWriter
+      def write(filename, xml)
+        require 'zlib'
+        Zlib::GzipWriter.open(filename) do |gz_file|
+          gz_file.write xml
+        end
+      end
+    end
+
+  end
+
+end
+

data/lib/simple_sitemap/writers/plain_writer.rb

@@ -0,0 +1,17 @@
+
+module SimpleSitemap
+
+  module Writers
+
+    class PlainWriter
+      def write(filename, xml)
+        File.open(filename, 'w') do |file|
+          file.write xml
+        end
+      end
+    end
+
+  end
+
+end
+

data/simple_sitemap.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'simple_sitemap/version'
+
+Gem::Specification.new do |gem|
+
+  gem.name          = 'simple_sitemap'
+  gem.version       = SimpleSitemap::VERSION
+
+  gem.add_dependency 'nokogiri', '~> 1.5.0'
+
+  gem.authors       = ['ryanlower']
+  gem.email         = ['rpjlower@gmail.com']
+  gem.description   = 'A simple sitemap generator'
+  gem.summary       = 'Simple sitemap generator'
+  gem.homepage      = 'https://github.com/academia-edu/simple-sitemap'
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: simple_sitemap
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- ryanlower
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &70222280337640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70222280337640
+description: A simple sitemap generator
+email:
+- rpjlower@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/simple_sitemap.rb
+- lib/simple_sitemap/generators/base.rb
+- lib/simple_sitemap/generators/index.rb
+- lib/simple_sitemap/generators/sitemap.rb
+- lib/simple_sitemap/version.rb
+- lib/simple_sitemap/writers/gzip_writer.rb
+- lib/simple_sitemap/writers/plain_writer.rb
+- simple_sitemap.gemspec
+homepage: https://github.com/academia-edu/simple-sitemap
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Simple sitemap generator
+test_files: []