dynamic_sitemaps 1.0.8 → 2.0.0.beta

data/lib/dynamic_sitemaps/rails/engine.rb

@@ -0,0 +1,9 @@
+module DynamicSitemaps
+  class Engine < Rails::Engine
+    engine_name :dynamic_sitemaps
+
+    rake_tasks do
+      load "dynamic_sitemaps/tasks/sitemap.rake"
+    end
+  end
+end

data/lib/dynamic_sitemaps/sitemap.rb

@@ -1,11 +1,46 @@
 module DynamicSitemaps
   class Sitemap
-    class << self
-      attr_reader :draw_block
-      
-      def draw(&block)
-        @draw_block = block
+    attr_reader :name, :collection, :block, :host, :folder
+
+    # Initializes a sitemap object.
+    # 
+    #   Sitemap.new(:site) do
+    #     url root_url
+    #   end
+    # 
+    # Using an ActiveRecord relation:
+    # 
+    #   Sitemap.new(:site, Product.visible) do |product|
+    #     url product
+    #     url product_editions_path(product)
+    #   end
+    
+    def initialize(*args, &block)
+      if args.first.is_a?(Symbol)
+        @name = args.shift
       end
+
+      if args.last.is_a?(Hash)
+        options = args.pop
+        @per_page = options[:per_page]
+        @host = options[:host]
+        @folder = options[:folder]
+        @collection = options[:collection]
+      end
+
+      @block = block
+    end
+
+    def root_url
+      "http://#{host}"
+    end
+
+    def per_page
+      @per_page ||= DynamicSitemaps::DEFAULT_PER_PAGE
+    end
+
+    # Generates sitemap XML files based on this sitemap
+    def generate
     end
   end
 end

data/lib/dynamic_sitemaps/sitemap_generator.rb

@@ -0,0 +1,153 @@
+module DynamicSitemaps
+  class SitemapGenerator
+    attr_reader :sitemap
+    attr_writer :counter, :page
+
+    def initialize(sitemap)
+      unless self.class.included_modules.include?(Rails.application.routes.url_helpers)
+        self.class.send :include, Rails.application.routes.url_helpers
+      end
+      @sitemap = sitemap
+    end
+
+    def generate
+      write_beginning
+      write_urls
+      write_end
+      
+      file.close
+      
+      SitemapResult.new(sitemap, files)
+    end
+
+    def write_beginning
+      write '<?xml version="1.0" encoding="UTF-8"?>',
+            '<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">'
+    end
+
+    def write_urls
+      if sitemap.collection
+        handle_collection
+      else
+        instance_eval &sitemap.block
+      end
+    end
+
+    def write_url(url, options = {})
+      write '<url>'
+      write '<loc>' + format_url(url) + '</loc>'
+      if last_mod = options[:last_mod]
+        write '<lastmod>' + format_date(last_mod) + '</lastmod>'
+      end
+      if change_freq = options[:change_freq]
+        write '<changefreq>' + change_freq + '</changefreq>'
+      end
+      if priority = options[:priority]
+        write '<priority>' + priority.to_s + '</priority>'
+      end
+      write '</url>'
+    end
+
+    def write_end
+      write '</urlset>'
+    end
+
+    def write(*lines)
+      file.puts lines
+    end
+
+    def handle_collection
+      sitemap.collection.find_each do |record|
+        if sitemap.block
+          instance_exec record, &sitemap.block
+        else
+          url record, last_mod: (record.respond_to?(:updated_at) ? record.updated_at : nil)
+        end
+      end
+    end
+
+    def per_page
+      sitemap.per_page
+    end
+
+    def page
+      @page ||= 1
+    end
+
+    def counter
+      @counter ||= 0
+    end
+
+    def increment_counter
+      self.counter += 1
+    end
+
+    def reset_counter
+      @counter = 1
+    end
+
+    def file_name
+      sitemap.name.to_s + (page > 1 ? page.to_s : "") + ".xml"
+    end
+
+    def folder
+      sitemap.folder
+    end
+
+    def folder_path
+      "#{DynamicSitemaps.path}/#{folder}"
+    end
+
+    def path
+      "#{folder_path}/#{file_name}"
+    end
+
+    def host
+      sitemap.host
+    end
+
+    def file
+      @file ||= begin
+        files << file_name
+        FileUtils.mkdir_p folder_path
+        File.open(path, "w")
+      end
+    end
+
+    def files
+      @files ||= []
+    end
+
+    def next_page
+      write_end
+      reset_counter
+      file.close
+      @file = nil
+      self.page += 1
+      write_beginning
+    end
+
+    def url(url, options = {})
+      increment_counter
+      next_page if counter > per_page
+      write_url url, options
+    end
+
+    def format_url(url)
+      case url
+      when ActiveRecord::Base
+        polymorphic_url(url)
+      else
+        url
+      end
+    end
+
+    def format_date(date)
+      if date.is_a?(Date)
+        date.strftime("%Y-%m-%d")
+      else
+        date.to_datetime.strftime("%Y-%m-%dT%H:%M:%S%:z")
+      end
+    end
+  end
+end

data/lib/dynamic_sitemaps/sitemap_result.rb

@@ -0,0 +1,24 @@
+# Contains the result of a sitemap generation
+
+module DynamicSitemaps
+  class SitemapResult
+    attr_reader :sitemap, :files
+
+    def initialize(sitemap, files)
+      @sitemap = sitemap
+      @files = files
+    end
+
+    def name
+      sitemap.name
+    end
+
+    def host
+      sitemap.host
+    end
+
+    def folder
+      sitemap.folder
+    end
+  end
+end

data/lib/dynamic_sitemaps/tasks/sitemap.rake

@@ -0,0 +1,12 @@
+namespace :sitemap do
+  task :generate => :environment do
+    start_time = Time.now
+    puts "Generating sitemap..."
+    DynamicSitemaps.generate_sitemap
+    puts "Done generating sitemap in #{Time.now - start_time} seconds."
+
+    if Rails.env.production?
+      DynamicSitemaps::Pinger.ping_search_engines
+    end
+  end
+end

data/lib/dynamic_sitemaps/version.rb

@@ -0,0 +1,3 @@
+module DynamicSitemaps
+  VERSION = "2.0.0.beta"
+end

data/lib/generators/dynamic_sitemaps/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Generates a config file for DynamicSitemaps.
+
+Example:
+    rails generate dynamic_sitemaps:install
+
+    This will create:
+        config/sitemap.rb

data/lib/generators/dynamic_sitemaps/install_generator.rb

@@ -0,0 +1,9 @@
+module DynamicSitemaps
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+    
+    def create_config
+      copy_file "config.rb", "config/sitemap.rb"
+    end
+  end
+end

data/lib/generators/dynamic_sitemaps/templates/config.rb

@@ -0,0 +1,7 @@
+host "www.example.com"
+
+sitemap :site do
+  url root_url, last_mod: Time.now, change_freq: "daily", priority: 1.0
+
+  # TODO: Add examples
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.