taq-sitemapper 0.0.3 → 0.0.4

data/README

@@ -0,0 +1,12 @@
+This is a simple class to write a website sitemap file.
+You can use it on two ways:
+
+As a class
+
+You can create a class and tell it to write the sitemap file when needed, 
+sending it a collection with the data to be written and optionally another one
+with extra data. The extra data can be used, for example, to send static urls
+that are not part of the first collection.
+
+
+

data/doc/sitemapper_class.rb

@@ -0,0 +1,11 @@
+require "rubygems"
+require "taq-sitemapper"
+
+data = [{url: "One"  , lastmod: Time.now, freq: "monthly", priority: 1}, 
+        {url: "Two"  , lastmod: Time.now, freq: "monthly", priority: 1}, 
+        {url: "Three", lastmod: Time.now, freq: "monthly", priority: 1}]
+
+sitemapper = Sitemapper::Sitemapper.new
+sitemapper.loc  = :url
+sitemapper.file = "/tmp/sitemap_class.xml"
+sitemapper.write_sitemap(data.entries)

data/lib/taq-sitemapper.rb

@@ -0,0 +1,86 @@
+require "builder"
+require "open-uri"
+
+module SiteMapper
+   module BaseMethods
+      def write_sitemap(collection=nil,extra_collection=nil)
+         file_ref       = @file        || (@sitemap[:file] rescue nil)
+         loc_ref        = @loc         || (@sitemap[:loc] rescue nil)
+         lastmod_ref    = @lastmod     || (@sitemap[:lastmod] rescue nil)
+         changefreq_ref = @changefreq  || (@sitemap[:changefreq] rescue nil)
+         priority_ref   = @priority    || (@sitemap[:priority] rescue nil)
+
+         return false if file_ref.nil?
+
+         if collection.nil? && !(@sitemap[:collection] rescue nil).nil?
+            collection = send(@sitemap[:collection])
+         end
+         if extra_collection.nil? && !(@sitemap[:extra] rescue nil).nil?
+            extra_collection = send(@sitemap[:extra])
+         end
+
+         xml = Builder::XmlMarkup.new(:indent=>2)
+         collection = extra_collection + collection if extra_collection
+
+         xml.urlset(:xmlns => "http://www.sitemaps.org/schemas/sitemap/0.9") do
+            collection.each do |value|
+               loc      = value.respond_to?(loc_ref.to_s.to_sym)        ? value.send(loc_ref)        : value[loc_ref]
+               lastmod  = value.respond_to?(lastmod_ref.to_s.to_sym)    ? value.send(lastmod_ref)    : value[lastmod_ref]
+               change   = value.respond_to?(changefreq_ref.to_s.to_sym) ? value.send(changefreq_ref) : value[changefreq_ref]
+               priority = value.respond_to?(priority_ref.to_s.to_sym)   ? value.send(priority_ref)   : value[priority_ref]
+
+               change   = changefreq_ref  if !change
+               priority = priority_ref    if !priority
+
+               xml.url do
+                  xml.loc        loc
+                  xml.lastmod    lastmod 
+                  xml.changefreq change
+                  xml.priority   priority
+               end                  
+            end
+         end
+         content = xml.target!
+         File.open(file_ref,"w") do |file|
+            file << content
+         end
+         content
+      end
+
+      def ping
+         url_ref = @url || (@sitemap[:url] rescue nil)
+         return if url_ref.nil?
+         open("http://www.google.com/webmasters/tools/ping?sitemap=#{url_ref}").read
+      end
+   end
+
+   def self.included(where)
+      where.extend(BaseMethods)   
+      class << where
+         attr_accessor :sitemap
+      end
+      where.sitemap = {}
+      where.sitemap[:url]        = nil
+      where.sitemap[:loc]        = :loc
+      where.sitemap[:lastmod]    = :lastmod
+      where.sitemap[:changefreq] = "daily"
+      where.sitemap[:priority]   = 1.00
+      where.sitemap[:file]       = "/tmp/sitemap.xml"
+      where.sitemap[:collection] = :all
+      where.sitemap[:extra]      = nil
+   end
+
+   class SiteMapper
+      include BaseMethods
+      attr_accessor :url, :loc, :lastmod, :changefreq, :priority, :file
+
+      def initialize
+         @url        = nil
+         @loc        = :loc
+         @lastmod    = :lastmod
+         @changefreq = "daily"
+         @priority   = 1.00
+         @file       = nil
+      end
+   end
+end

data/lib/{sitemapper → taq-sitemapper}/version.rb

@@ -1,3 +1,3 @@
 module SiteMapper
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/{sitemapper.gemspec → taq-sitemapper.gemspec}

@@ -1,17 +1,17 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
-require "sitemapper/version"
+require "taq-sitemapper/version"
 
 Gem::Specification.new do |s|
   s.name        = "taq-sitemapper"
   s.version     = SiteMapper::VERSION
   s.authors     = ["Eustaquio Rangel"]
   s.email       = ["eustaquiorangel@gmail.com"]
-  s.homepage    = ""
+  s.homepage    = "https://github.com/taq/sitemapper"
   s.summary     = %q{Create a sitemap}
   s.description = %q{Create a sitemap with a data collection}
 
-  s.rubyforge_project = "sitemapper"
+  s.rubyforge_project = "taq-sitemapper"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/test/sitemapper_test.rb

@@ -1,8 +1,26 @@
+require "rubygems"
 require "nokogiri"
 require "test/unit"
-require "#{File.expand_path(File.dirname(__FILE__))}/collections.rb"
+require "active_record"
 require "#{File.expand_path(File.dirname(__FILE__))}/../lib/sitemapper.rb"
 
+ActiveRecord::Base.establish_connection({ 
+   adapter: "sqlite3",
+   database: "sitemapper.sqlite"
+})
+
+class SitemapperTestAR < ActiveRecord::Base  
+   include SiteMapper
+   def self.sitemap_extra
+      [{loc: "One"  , lastmod: Time.now, freq: "monthly", priority: 1}, 
+       {loc: "Two"  , lastmod: Time.now, freq: "monthly", priority: 1}, 
+       {loc: "Three", lastmod: Time.now, freq: "monthly", priority: 1}]
+   end
+   def loc
+      url
+   end
+end
+
 class SiteMapperTest < Test::Unit::TestCase
    def setup
       @arraytest = [{url: "One"  , lastmod: Time.now, freq: "monthly", priority: 1}, 
@@ -14,27 +32,74 @@ class SiteMapperTest < Test::Unit::TestCase
       @sitemapper.loc = :url
       @sitemapper.changefreq = :freq
       @sitemapper.priority = :priority
-      @sitemapper.sitemap = "/tmp/sitemap.xml"
+      @sitemapper.file = "/tmp/sitemap.xml"
    end   
 
    def test_write_sitemap
-      File.unlink(@sitemapper.sitemap) if File.exists?(@sitemapper.sitemap)
+      File.unlink(@sitemapper.file) if File.exists?(@sitemapper.file)
       @sitemapper.write_sitemap(@arraytest.entries) 
-      assert File.exists?(@sitemapper.sitemap), "sitemap file not found"
+      assert File.exists?(@sitemapper.file), "sitemap file not found"
    end
 
    def test_url_size
       test_write_sitemap
-      doc = Nokogiri::XML(File.open(@sitemapper.sitemap))
+      doc = Nokogiri::XML(File.open(@sitemapper.file))
       assert_equal @arraytest.entries.size, doc.search("url").size
    end
 
    def test_write_sitemap_with_extras
-      File.unlink(@sitemapper.sitemap) if File.exists?(@sitemapper.sitemap)
+      File.unlink(@sitemapper.file) if File.exists?(@sitemapper.file)
       extras = [{url: "Four", lastmod: Time.now, freq: "yearly", priority: 0.5}, 
                 {url: "Five", lastmod: Time.now, freq: "yearly", priority: 0.5}]
       @sitemapper.write_sitemap(@arraytest.entries,extras.entries) 
-      doc = Nokogiri::XML(File.open(@sitemapper.sitemap))
+      doc = Nokogiri::XML(File.open(@sitemapper.file))
       assert_equal @arraytest.entries.size+extras.size, doc.search("url").size
    end
+
+   def test_ar_class_methods
+      assert_respond_to SitemapperTestAR, :write_sitemap
+      assert_respond_to SitemapperTestAR, :ping
+   end
+
+   def test_ar_class_attrs
+      assert_respond_to SitemapperTestAR, :sitemap
+   end
+
+   def test_class_collection
+      assert_equal :all, SitemapperTestAR.sitemap[:collection]
+   end
+
+   def test_class_collection
+      assert_nil SitemapperTestAR.sitemap[:extra]
+   end
+   
+   def test_rw_class_attrs
+      str = "yearly"
+      SitemapperTestAR.sitemap[:changefreq] = str
+      assert_equal str, SitemapperTestAR.sitemap[:changefreq]
+   end
+
+   def test_class_methods_default_values
+      assert_equal "daily", SitemapperTestAR.sitemap[:changefreq]
+   end
+
+   def test_write_sitemap_on_class
+      file = SitemapperTestAR.sitemap[:file]
+      File.unlink(file) if File.exists?(file)
+      SitemapperTestAR.write_sitemap
+      assert File.exists?(file), "sitemap file not found"
+      doc = Nokogiri::XML(File.open(file))
+      assert_equal SitemapperTestAR.all.size, doc.search("url").size
+   end
+
+   def test_write_sitemap_on_class_with_extras
+      file = SitemapperTestAR.sitemap[:file]
+      File.unlink(file) if File.exists?(file)
+      SitemapperTestAR.sitemap[:extra] = :sitemap_extra
+  
+      SitemapperTestAR.write_sitemap
+      assert File.exists?(file), "sitemap file not found"
+      doc = Nokogiri::XML(File.open(file))
+      assert_equal SitemapperTestAR.all.size+3, doc.search("url").size
+   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: taq-sitemapper
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-28 00:00:00.000000000Z
+date: 2012-01-29 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &82914730 !ruby/object:Gem::Requirement
+  requirement: &78621310 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *82914730
+  version_requirements: *78621310
 - !ruby/object:Gem::Dependency
   name: builder
-  requirement: &82914470 !ruby/object:Gem::Requirement
+  requirement: &78620770 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *82914470
+  version_requirements: *78620770
 description: Create a sitemap with a data collection
 email:
 - eustaquiorangel@gmail.com
@@ -42,12 +42,15 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
+- README
 - Rakefile
-- lib/sitemapper.rb
-- lib/sitemapper/version.rb
-- sitemapper.gemspec
+- doc/sitemapper_class.rb
+- lib/taq-sitemapper.rb
+- lib/taq-sitemapper/version.rb
+- taq-sitemapper.gemspec
+- test/sitemapper.sqlite
 - test/sitemapper_test.rb
-homepage: ''
+homepage: https://github.com/taq/sitemapper
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -66,7 +69,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: sitemapper
+rubyforge_project: taq-sitemapper
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3

data/lib/sitemapper.rb

@@ -1,53 +0,0 @@
-require "builder"
-require "open-uri"
-
-module SiteMapper
-   class SiteMapper
-      attr_accessor :url, :loc, :lastmod, :changefreq, :priority, :sitemap
-
-      def initialize
-         @url        = nil
-         @loc        = :loc
-         @lastmod    = :lastmod
-         @changefreq = "daily"
-         @priority   = 1.00
-         @sitemap    = nil
-      end
-
-      def write_sitemap(collection,extra_collection=nil)
-         return false if @sitemap.nil?
-
-         xml = Builder::XmlMarkup.new(:indent=>2)
-         collection = extra_collection + collection if extra_collection
-
-         xml.urlset(:xmlns => "http://www.sitemaps.org/schemas/sitemap/0.9") do
-            collection.each do |value|
-               loc      = value.respond_to?(@loc.to_s.to_sym)        ? value.send(@loc)        : value[@loc]
-               lastmod  = value.respond_to?(@lastmod.to_s.to_sym)    ? value.send(@lastmod)    : value[@lastmod]
-               change   = value.respond_to?(@changefreq.to_s.to_sym) ? value.send(@changefreq) : value[@changefreq]
-               priority = value.respond_to?(@priority.to_s.to_sym)   ? value.send(@priority)   : value[@priority]
-
-               change   = @changefreq  if !change
-               priority = @priority    if !priority
-
-               xml.url do
-                  xml.loc        loc
-                  xml.lastmod    lastmod 
-                  xml.changefreq change
-                  xml.priority   priority
-               end                  
-            end
-         end
-         content = xml.target!
-         File.open(sitemap,"w") do |file|
-            file << content
-         end
-         content
-      end
-
-      def ping
-         return if @url.nil?
-         open("http://www.google.com/webmasters/tools/ping?sitemap=#{@url}").read
-      end
-   end
-end