sitespec 0.0.5 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 77d72de6ad811ebe5d8ec22b950095fd12bdc010
-  data.tar.gz: 257c93ecebde01574fa958e1b2fc3c42ba0b6f97
+  metadata.gz: d9fc89ff9faa0578468ba10193d3c0ce7503a2c9
+  data.tar.gz: 5de14be6b1383849c8027a460eb1a6815be8f239
 SHA512:
-  metadata.gz: 09f1380c36ee72d02649fcb5c4272e29d10d5c1e5f99cdae2ef19bc18a202f52d906f92d61c2c366706290bfe4920fbea217489e93be8a27cd1898d93188437d
-  data.tar.gz: d4a531f5208a4402b66e1e4aee61808ed64179808228052d8957523714ae93fb60a35d9991e3b9a5d03976b2184ab8dbb96f31fef4fbeffe8f8f9854ab715fe1
+  metadata.gz: 0dcf588bd912f06ec9a57677e76ac66684fcd8afbb91de6f1d8e097bec25dcde54b53bbc75cc90d425c903cc9f85ffa7e3cfafc26b5e02d0745ce42359ec6593
+  data.tar.gz: 431a14bb5c21985f7be8154c985f22e1efb2b84eca0210bd1a159cbda6caee36bdd2b12b923ffb2a4f2379469fe89ab96e5fc8d317de7c18e3caeb3cdd1962a5

data/CHANGELOG.md

@@ -1,15 +1,18 @@
+## 1.0.0
+- Renewal with Ruby 2, RSpec 3, and rack-test
+
 ## 0.0.5
-* Fix dependent RSpec version
+- Fix dependent RSpec version
 
 ## 0.0.4
-* Support Ruby 1.9.x
+- Support Ruby 1.9.x
 
 ## 0.0.3
-* Fix rspec gem dependency
+- Fix rspec gem dependency
 
 ## 0.0.2
-* Pretty RSpec formatter
+- Pretty RSpec formatter
 
 ## 0.0.1
-* Basic features to generate files from request spec
-* The 1st release on 2013-11-15
+- Basic features to generate files from request spec
+- The 1st release on 2013-11-15

data/README.md

@@ -1,56 +1,77 @@
 # Sitespec
 Generate static site from your rack application & spec definition.
 
-## Features
 * Provides the same way to create both dynamic & static website
 * Generates static website from your existing dynamic website
 * Sitespec can be executable specification, good documentation, and well-tested implementation
 
-## Installation
-```sh
-# shell-command
-gem install sitespec
+## Usage
+### Add sitespec into your Gemfile
+```rb
+# Gemfile
+gem "sitespec"
 ```
 
-## Usage
-```ruby
-# spec/your_spec.rb
-require "sitespec"
-
-Sitespec.configure do
-  self.application = MyRackApplication.new
-  self.build_path = "build"
-  self.raise_http_error = true
-end
+### Require sitespec/rspec in your specs
+```rb
+# spec/spec_helper.rb
+require "sitespec/rspec"
+```
+
+### Write request-specs with `:sitespec` metadata
+Note: [rack/test](https://github.com/brynary/rack-test) is automatically enabled
+in the example groups that have `:sitespec`.
 
+```rb
+# spec/site_spec.rb
 describe "Sitespec" do
-  include Sitespec
-
-  it "generates static site from your rack application & spec definition" do
-    get "/2000/01/01/hello.html"
-    get "/2000/01/02/world.html"
-    get "/feed.xml"
-    get "/images/favicon.ico"
-    get "/index.html"
-    get "/stylesheets/all.css"
+  let(:app) do
+    MyRackApp
+  end
+
+  %w[
+    /2000/01/01/hello.html
+    /2000/01/02/world.html
+    /feed.xml
+    /images/favicon.ico
+    /index.html
+    /stylesheets/all.css
+  ].each do |path|
+    describe "GET #{path}", :sitespec do
+      it "returns 200" do
+        expect(get(path).status).to eq 200
+      end
+    end
   end
 end
 ```
 
-```sh
-# shell-command
-$ rspec
-Build started...
+### Run rspec to build static files
+Note: only successful examples generate static files.
 
-✔ 2000/01/01/hello.html
-✔ 2000/01/02/world.html
-✔ feed.xml
-✔ images/favicon.ico
-✔ index.html
-✔ stylesheets/all.css
+```
+$ bundle exec rspec
 
-Build finished with 6 files in 0.00151 seconds.
+Example application
+  GET /2000-01-01-hello.html
+    returns 200
+  GET /index.html
+    returns 200
+  GET /stylesheets/all.css
+    returns 200
+
+Finished in 0.08302 seconds (files took 0.79161 seconds to load)
+3 examples, 0 failures
 ```
 
-## Example
-[r7kamura/r7kamura.github.io](https://github.com/r7kamura/r7kamura.github.io) is powered by sitespec.
+## Configuration
+- `Sitespec.configuration.build_path` - Where to locate files (default: `"build"`)
+- `Sitespec.configuration.enabled` - Flag to enable sitespec (default: `true`)
+
+## Advanced topics
+Sitespec is excellent with GitHub Pages.
+[r7kamura/r7kamura.github.io](https://github.com/r7kamura/r7kamura.github.io)
+is a working example that uses Sitespec to build static files from Rack application.
+It uses TravisCI to build and push files to GitHub repo's master branch.
+See [.travis.yml](https://github.com/r7kamura/r7kamura.github.io/blob/source/.travis.yml)
+for more information about how to to it.

data/lib/sitespec.rb

@@ -1,52 +1,29 @@
-require "sitespec/builder"
+require "sitespec/artifact"
 require "sitespec/configuration"
-require "sitespec/error"
-require "sitespec/formatter"
-require "sitespec/request"
-require "sitespec/response"
 require "sitespec/version"
-require "sitespec/writer"
-require "sitespec/initialize"
 
 module Sitespec
   class << self
-    attr_writer :build_count
+    attr_writer :artifacts_count
 
-    def configuration
-      @configuration ||= Configuration.new
+    def artifacts_count
+      @artifacts_count || 0
     end
 
-    def configure(&block)
-      configuration.instance_eval(&block)
+    # Provide singleton configuration object shared with the current process.
+    # @example
+    #   Sitespec.configuration.build_path = "artifacts"
+    def configuration
+      @configuration ||= Sitespec::Configuration.new
     end
 
-    def build_count
-      @build_count ||= 0
+    # Provide friendly interface to access to Sitespec.configuration.
+    # @example
+    #   Sitespec.configure do |configuration|
+    #     configuration.build_path = "artifacts"
+    #   end
+    def configure(&block)
+      block.call(configuration)
     end
   end
-
-  module_function
-
-  attr_reader :request, :response
-
-  def get(path, params = {}, env = {})
-    process(:get, path, params, env)
-  end
-
-  def post(path, params = {}, env = {})
-    process(:post, path, params, env)
-  end
-
-  def put(path, params = {}, env = {})
-    process(:put, path, params, env)
-  end
-
-  def delete(path, params = {}, env = {})
-    process(:delete, path, params, env)
-  end
-
-  def process(*args)
-    @request = Request.new(*args)
-    @response = Builder.build(@request)
-  end
 end

data/lib/sitespec/artifact.rb

@@ -0,0 +1,89 @@
+require "pathname"
+require "sitespec"
+
+module Sitespec
+  # "Artifact" is corresponding to each response body to an endpoint.
+  # This class has ActiveRecord-like interface like Sitespec::Artifact.create.
+  #
+  # @example
+  #   Sitespec::Artifact.create(example: example, example_group: example_group)
+  #
+  class Artifact
+    class << self
+      # Short-hand method to call `.new` and `#save`
+      # @return [Sitespec::Artifact]
+      def create(**args)
+        new(**args).tap(&:save)
+      end
+    end
+
+    # @param [RSpec::Core::Example] example In almost cases, `RSpec.current_example` is passed
+    # @param [RSpec::Core::ExampleGroup] example_group In almost cases, `self` is passed
+    def initialize(example: nil, example_group: nil)
+      @example = example
+      @example_group = example_group
+    end
+
+    # Validate its attributes and generate a new file
+    # @return [false, true] True for successful case, otherwise false
+    def save
+      if valid?
+        write
+        count_up
+        true
+      else
+        false
+      end
+    end
+
+    private
+
+    def count_up
+      Sitespec.artifacts_count += 1
+    end
+
+    # Utility method to access to `@example`
+    def example
+      @example
+    end
+
+    # Utility method to access to `@example_group`
+    def example_group
+      @example_group
+    end
+
+    def generate_file
+      pathname.write(response.body)
+    end
+
+    def make_parent_directory
+      pathname.parent.mkpath
+    end
+
+    # @return [Pathname] Where to an artifact file is located
+    def pathname
+      Pathname.new(File.join(Sitespec.configuration.build_pathname, request.path))
+    end
+
+    # @note We expect `request` is provided via rack-test
+    def request
+      example_group.last_request
+    end
+
+    # @note We expect `response` is provided via rack-test
+    def response
+      example_group.last_response
+    end
+
+    # @return [false, true] Validation result
+    def valid?
+      example.exception.nil? && Sitespec.configuration.enabled?
+    end
+
+    # Generate directory and file
+    def write
+      make_parent_directory
+      generate_file
+    end
+  end
+end

data/lib/sitespec/configuration.rb

@@ -1,10 +1,35 @@
+require "pathname"
+
 module Sitespec
   class Configuration
-    attr_accessor :application, :build_path, :raise_http_error
+    DEFAULT_BUILD_PATH = "build"
+
+    attr_writer :build_path
 
     def initialize
-      @build_path = "build"
-      @raise_http_error = true
+      @enabled = true
+    end
+
+    def build_path
+      @build_path || DEFAULT_BUILD_PATH
+    end
+
+    # @return [Pathname]
+    def build_pathname
+      Pathname.new(build_path)
+    end
+
+    def disable
+      @enabled = false
+    end
+
+    def enable
+      @enabled = true
+    end
+
+    def enabled
+      !!@enabled
     end
+    alias_method :enabled?, :enabled
   end
 end

data/lib/sitespec/rspec.rb

@@ -0,0 +1,20 @@
+# This file does not provide any class or module named Sitespec::RSpec,
+# but configures suitable settings to run Sitespec with RSpec.
+
+require "rack/test"
+require "rspec"
+require "sitespec"
+
+RSpec.configure do |config|
+  config.include Rack::Test::Methods, sitespec: true
+
+  config.after do |example|
+    Sitespec::Artifact.create(example: example, example_group: self)
+  end
+
+  config.after(:suite) do
+    if Sitespec.artifacts_count > 0
+      puts "\nSitespec generated #{Sitespec.artifacts_count} files into #{Sitespec.configuration.build_path} directory."
+    end
+  end
+end

data/lib/sitespec/version.rb

@@ -1,3 +1,3 @@
 module Sitespec
-  VERSION = "0.0.5"
+  VERSION = "1.0.0"
 end

data/sitespec.gemspec

@@ -10,13 +10,14 @@ Gem::Specification.new do |spec|
   spec.summary       = "Generate static site from your rack application & spec definition"
   spec.homepage      = "https://github.com/r7kamura/sitespec"
   spec.license       = "MIT"
-
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
+  spec.required_ruby_version = ">= 2.0.0"
 
-  spec.add_dependency "rspec", "~> 2.14.1"
+  spec.add_dependency "rack-test"
+  spec.add_dependency "rspec", ">= 3.0.0"
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "padrino"
   spec.add_development_dependency "pry"

data/spec/sitespec_spec.rb

@@ -1,9 +1,19 @@
 require "spec_helper"
 
-describe Sitespec do
-  it "generates static files from rack application" do
-    get "/stylesheets/all.css"
-    get "/index.html"
-    get "/2000-01-01-hello.html"
+describe "Example application" do
+  let(:app) do
+    Sitespec::ExampleApplication
+  end
+
+  %w[
+    /2000-01-01-hello.html
+    /index.html
+    /stylesheets/all.css
+  ].each do |path|
+    describe "GET #{path}", :sitespec do
+      it "returns 200" do
+        expect(get(path).status).to eq 200
+      end
+    end
   end
 end

data/spec/spec_helper.rb

@@ -1,11 +1,3 @@
-$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
-require "sitespec"
+require "sitespec/rspec"
 
 Dir[File.expand_path("../support/**/*.rb", __FILE__)].each {|f| require f }
-
-RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
-  config.include Sitespec
-end
-
-Sitespec.configuration.application = Sitespec::ExampleApplication

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: sitespec
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 1.0.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-30 00:00:00.000000000 Z
+date: 2015-05-15 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.14.1
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.14.1
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -136,15 +150,10 @@ files:
 - README.md
 - Rakefile
 - lib/sitespec.rb
-- lib/sitespec/builder.rb
+- lib/sitespec/artifact.rb
 - lib/sitespec/configuration.rb
-- lib/sitespec/error.rb
-- lib/sitespec/formatter.rb
-- lib/sitespec/initialize.rb
-- lib/sitespec/request.rb
-- lib/sitespec/response.rb
+- lib/sitespec/rspec.rb
 - lib/sitespec/version.rb
-- lib/sitespec/writer.rb
 - sitespec.gemspec
 - spec/sitespec_spec.rb
 - spec/spec_helper.rb
@@ -167,7 +176,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -175,7 +184,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Generate static site from your rack application & spec definition
@@ -189,4 +198,3 @@ test_files:
 - spec/support/application/views/index.slim
 - spec/support/application/views/layouts/application.slim
 - spec/support/application/views/show.slim
-has_rdoc: 

data/lib/sitespec/builder.rb

@@ -1,23 +0,0 @@
-module Sitespec
-  class Builder
-    def self.build(*args)
-      new(*args).build
-    end
-
-    def initialize(request)
-      @request = request
-    end
-
-    def build
-      Response.new(*call).tap {|response| Writer.write(@request, response) }
-    end
-
-    def call
-      Sitespec.configuration.application.call(@request.env).tap do |status, header, body|
-        if Sitespec.configuration.raise_http_error && status >= 400
-          raise Error, "#{@request.uri} returned #{status}"
-        end
-      end
-    end
-  end
-end

data/lib/sitespec/error.rb

@@ -1,4 +0,0 @@
-module Sitespec
-  class Error < StandardError
-  end
-end

data/lib/sitespec/formatter.rb

@@ -1,19 +0,0 @@
-require "rspec/core/formatters/documentation_formatter"
-
-module Sitespec
-  class Formatter < RSpec::Core::Formatters::BaseTextFormatter
-    def start(*)
-      super
-      output.puts "Build started...\n\n"
-    end
-
-    def dump_summary(duration, example_count, failure_count, pending_count)
-      @duration = duration
-      @example_count = example_count
-      @failure_count = failure_count
-      @pending_count = pending_count
-      output.puts "\nBuild finished with #{Sitespec.build_count} files in #{format_duration(duration)}.\n"
-      dump_commands_to_rerun_failed_examples
-    end
-  end
-end

data/lib/sitespec/initialize.rb

@@ -1,2 +0,0 @@
-RSpec.configuration.formatters.clear
-RSpec.configuration.formatter = Sitespec::Formatter

data/lib/sitespec/request.rb

@@ -1,40 +0,0 @@
-require "stringio"
-require "uri"
-
-module Sitespec
-  class Request
-    def initialize(method, path, params = {}, custom_env = {})
-      @custom_env = custom_env
-      @method = method
-      @params = params
-      @path = path
-    end
-
-    def env
-      @env ||= {
-        "HTTPS" => https? ? "on" : "off",
-        "HTTP_HOST" => uri.host,
-        "PATH_INFO" => uri.path,
-        "QUERY_STRING" => uri.query || "",
-        "REQUEST_METHOD" => @method.to_s.upcase,
-        "REQUEST_URI" => uri.to_s,
-        "SERVER_NAME" => uri.hostname,
-        "SERVER_PORT" => uri.port,
-        "rack.errors" => StringIO.new,
-        "rack.input" => StringIO.new,
-        "rack.multithread" => false,
-        "rack.run_once" => false,
-        "rack.url_scheme" => https? ? "http" : "https",
-        "rack.version" => [1, 1],
-      }.merge(@custom_env)
-    end
-
-    def uri
-      @uri ||= URI.parse(@path)
-    end
-
-    def https?
-      URI::HTTP === uri && uri.https?
-    end
-  end
-end

data/lib/sitespec/response.rb

@@ -1,17 +0,0 @@
-module Sitespec
-  class Response
-    attr_reader :status, :header
-
-    def initialize(status, header, body)
-      @body = body
-      @header = header
-      @status = status
-    end
-
-    def body
-      lines = []
-      @body.each {|line| lines << line }
-      lines.join
-    end
-  end
-end

data/lib/sitespec/writer.rb

@@ -1,46 +0,0 @@
-# coding: utf-8
-module Sitespec
-  class Writer
-    def self.write(*args)
-      new(*args).write
-    end
-
-    def initialize(request, response)
-      @request = request
-      @response = response
-    end
-
-    def write
-      mkpath
-      create_with_output_and_build_count
-    end
-
-    def path
-      @path ||= Pathname.new("#{Sitespec.configuration.build_path}#{@request.uri.path}")
-    end
-
-    def mkpath
-      path.parent.mkpath
-    end
-
-    def create
-      path.open("w") {|file| file << @response.body }
-    end
-
-    def create_with_output
-      create.tap { puts "#{color(?✔)} #{path}" }
-    end
-
-    def create_with_output_and_build_count
-      create_with_output.tap { Sitespec.build_count += 1 }
-    end
-
-    def color(text)
-      RSpec.configuration.color_enabled? ? "\e[32m#{text}\e[0m" : text
-    end
-
-    def puts(text)
-      RSpec.configuration.formatters[0].output.puts text
-    end
-  end
-end