simple_sitemap_generator 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3a3cc4108d39a8f1bf68c5d66b4bb74240c931b0
-  data.tar.gz: 92c492af10be056a71c8f6b5bd816c13010f504f
+  metadata.gz: 5323e2b99f39639cd561858feb085f1026c193a5
+  data.tar.gz: e9f6f2bfaeba71a74f3251bb2af8e948975151c6
 SHA512:
-  metadata.gz: 2b72caf6b9b8f73362e007dcfedac82a677c556dc29728b5dd8e37dc9084964ae3c35d1fa152acadd585372d7e3344632a85f0e97b0516599cac54287ab65580
-  data.tar.gz: 56cc055f0e6466fe8418abfde11092c2250772734fd1c04b70561a9afe93f3246998ee4ee16c75a88da1017c6e9fee237df49a24e19d4e80b93e8467190ff35e
+  metadata.gz: 3845bda32bf2528e89047ae93b444562b73f6467bb75f3a787038234b02e0a57a6c73e38dfac8858e29f857df3889d7f51c2afe8879efc89534ca71799e085f6
+  data.tar.gz: d044fd399ee7279b0a4deaded581354529e5cb10f984404f54278139ffcb2bfd5e81f6ad778dc10c1dd36b233235c83377a63d13080da5c4962ef8e965033e78

data/README.md

@@ -1,8 +1,11 @@
 # SimpleSitemapGenerator
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/simple_sitemap_generator`. To experiment with that code, run `bin/console` for an interactive prompt.
+SimpleSitemapGenerator is a gem for Ruby on Rails to generate sitemap.xml.
 
-TODO: Delete this and the text above, and describe your gem
+## Features
+
+* Generates `sitemap.xml` **dynamically** by using `config/routes.rb`.
+* Enable to respond **without static file** (eg. `public/sitemap.xml`).
 
 ## Installation
 
@@ -21,8 +24,55 @@ Or install it yourself as:
     $ gem install simple_sitemap_generator
 
 ## Usage
+All you have to do is following.
+
+##### config/routes.rb
+```ruby
+get '/sitemap.xml', action: :sitemap, controller: :sitemap
+```
+
+##### app/controllers/sitemap_controller.rb
+```ruby
+class SitemapController < BaseController
+  def sitemap
+    send_data(SimpleSitemapGenerator::Sitemap.generate_xml, type: 'text/xml')
+  end
+end
+```
+
+##### config/initializers/sitemap.rb
+```ruby
+# Set the host name for URL creation
+SimpleSitemapGenerator::Sitemap.host = 'https://www.example.com'
+
+# [optional] Set default parameter
+SimpleSitemapGenerator::Sitemap.default_lastmod = Time.current
+SimpleSitemapGenerator::Sitemap.default_priority = 0.5
+SimpleSitemapGenerator::Sitemap.default_changefreq = 'daily'
+
+# [optional] Set additional_paths
+# NOTE: Output includes only static url (eg. '/users'), does not include dynamic url (eg. '/users/123').
+#       You should specify url if you want.
+SimpleSitemapGenerator::Sitemap.additional_paths = [
+  '/users/123',
+  *Article.published.map{ |a| "/articles/#{a.id}"},
+]
+
+# [optional] Set inappropriate paths for sitemap.xml by regular expression
+SimpleSitemapGenerator::Sitemap.inappropriate_paths += [
+  /^\/admin/,
+  /^\/mypage/,
+]
+
+# [optional] Set parameter to specific path if you want
+SimpleSitemapGenerator::Sitemap.options = {
+  '/': {
+    priority: 1.0,
+    changefreq: 'daily',
+  },
+}
+```
 
-TODO: Write usage instructions here
 
 ## Development
 
@@ -32,7 +82,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/simple_sitemap_generator. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/nullnull/simple_sitemap_generator. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 

data/lib/simple_sitemap_generator.rb

@@ -1,8 +1,8 @@
 module SimpleSitemapGenerator
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.2.0'.freeze
 
   class Generator
-    attr_accessor :host, :default_lastmod, :default_changefreq, :default_priority, :inappropriate_paths, :options
+    attr_accessor :host, :default_lastmod, :default_changefreq, :default_priority, :inappropriate_paths, :options, :additional_paths
 
     def generate_xml
       paths.map { |path| {
@@ -25,6 +25,7 @@ module SimpleSitemapGenerator
       ]
       @host = ''
       @options = {}
+      @additional_paths = []
     end
 
     private
@@ -42,11 +43,12 @@ module SimpleSitemapGenerator
     end
 
     def paths
-      routes.select{ |route| route.verb == 'GET' }
+      paths = routes.select{ |route| route.verb == 'GET' }
         .reject{ |route| redirect_path?(route) }
         .map { |route| route.path.spec.to_s.gsub('(.:format)', '') }
         .reject{ |path| inappropriate_path?(path) }
         .uniq
+      paths + additional_paths
     end
 
     def redirect_path?(route)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_sitemap_generator
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Katsuma Narisawa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-30 00:00:00.000000000 Z
+date: 2017-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -82,6 +82,7 @@ files:
 - bin/console
 - bin/setup
 - lib/simple_sitemap_generator.rb
+- pkg/simple_sitemap_generator-0.1.0.gem
 - simple_sitemap_generator.gemspec
 homepage: https://github.com/nullnull/simple_sitemap_generator
 licenses: