sitespec 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aebce21985d8078df2ad1316e59c50af7875aa0c
-  data.tar.gz: 6d1876b3790b7a3c23b8494f91a63bd139a92d79
+  metadata.gz: 95af9cafe48631ad6f7d042b5be5b80d5cef58e4
+  data.tar.gz: f4f2a7962845d247b00cf61126cd81c3e372c55c
 SHA512:
-  metadata.gz: 7a89ac98879b869473638475f2b8679e26cf7e2cfb32af84884c5b2edb2ca01f6d79058f06e76267c360a23fec33ba7bfc8c9068ec245516c69cdb5beb9117e5
-  data.tar.gz: 080a4c535fb11be1325fc8b50df792e72af17ac5eb76c5e1db97a2bb84fd16422db8cbd9f498fc8bb31c4a0841e02450ae02d9810e0b46494fdf09cd8655c018
+  metadata.gz: 86a8ccfad5216e8d089ac9a1e4932f2077718e4700e993d6044fe0ef2ae9cd018cfcbbf06427899ad535f1aad283dd09c630657b7d703d5fcb6ca93336913d48
+  data.tar.gz: e38379191d7540169a23da8bd35fac7f7ea12dafab2023cc1a4351d6631e24cb22e1e23541b026d6b6031e0a1d3306ad531295c48ff8d05f8d011776d7336dac

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 1.2.0
+- Allow users to generate index.html by putting trailing slash
+
 ## 1.1.0
 - Add auto_complete_html_path configuration (default: true)
 

data/README.md

@@ -30,11 +30,8 @@ describe "Sitespec" do
   end
 
   %w[
-    /2000/01/01/hello.html
-    /2000/01/02/world.html
-    /feed.xml
-    /images/favicon.ico
-    /index.html
+    /
+    /2000/01/01/hello
     /stylesheets/all.css
   ].each do |path|
     describe "GET #{path}", :sitespec do
@@ -53,21 +50,23 @@ Note: only successful examples generate static files.
 $ bundle exec rspec
 
 Example application
-  GET /2000-01-01-hello.html
+  GET /
     returns 200
-  GET /index.html
+  GET /2000/01/01/hello
     returns 200
   GET /stylesheets/all.css
     returns 200
 
+Sitespec generated 3 files into build directory.
+
 Finished in 0.08302 seconds (files took 0.79161 seconds to load)
 3 examples, 0 failures
 ```
 
 ## Configuration
-- `Sitespec.configuration.auto_complete_html_path` - Flag to autocomplete .html (default: `true`)
-- `Sitespec.configuration.build_path` - Where to locate files (default: `"build"`)
-- `Sitespec.configuration.enabled` - Flag to enable sitespec (default: `true`)
+- `Sitespec.configuration.auto_complete_html_path` - Autocomplete .html (default: true)
+- `Sitespec.configuration.build_path` - Where to locate files (default: build)
+- `Sitespec.configuration.enabled` - Enable sitespec (default: true)
 
 ## Advanced topics
 Sitespec is excellent with GitHub Pages.

data/lib/sitespec/artifact.rb

@@ -29,7 +29,7 @@ module Sitespec
     def save
       if valid?
         write
-        count_up
+        increment
         true
       else
         false
@@ -38,10 +38,6 @@ module Sitespec
 
     private
 
-    def count_up
-      Sitespec.artifacts_count += 1
-    end
-
     # Utility method to access to `@example`
     def example
       @example
@@ -56,6 +52,10 @@ module Sitespec
       pathname.write(response.body)
     end
 
+    def increment
+      Sitespec.increment_artifacts_count
+    end
+
     def make_parent_directory
       pathname.parent.mkpath
     end
@@ -72,7 +72,7 @@ module Sitespec
         ""
       when response.content_type.nil? || !response.content_type.include?("text/html") || request.path.end_with?(".html")
         ""
-      when request.path == "/"
+      when request.path.end_with?("/")
         "index.html"
       else
         ".html"

data/lib/sitespec/version.rb

@@ -1,3 +1,3 @@
 module Sitespec
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/lib/sitespec.rb

@@ -4,13 +4,15 @@ require "sitespec/version"
 
 module Sitespec
   class << self
-    attr_writer :artifacts_count
-
+    # Return how many artifacts (files) generated on this process.
+    # This count is to be shown after all examples are finished.
+    # @return [Integer]
     def artifacts_count
       @artifacts_count || 0
     end
 
     # Provide singleton configuration object shared with the current process.
+    # All of user-configuration should be stored in this singleton object.
     # @example
     #   Sitespec.configuration.build_path = "artifacts"
     def configuration
@@ -18,6 +20,8 @@ module Sitespec
     end
 
     # Provide friendly interface to access to Sitespec.configuration.
+    # The configuration object passed to given block is same with
+    # `Sitespec.configuration`.
     # @example
     #   Sitespec.configure do |configuration|
     #     configuration.build_path = "artifacts"
@@ -25,5 +29,11 @@ module Sitespec
     def configure(&block)
       block.call(configuration)
     end
+
+    # Use this method when a new artifact is generated.
+    # In almost cases, it's called from Sitespec::Artifact class.
+    def increment_artifacts_count
+      @artifacts_count = artifacts_count + 1
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sitespec
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-15 00:00:00.000000000 Z
+date: 2015-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack-test
@@ -198,3 +198,4 @@ test_files:
 - spec/support/application/views/index.slim
 - spec/support/application/views/layouts/application.slim
 - spec/support/application/views/show.slim
+has_rdoc: