middleman-apps 0.1.0 → 0.2.0

data/lib/middleman/sitemap/app_resource.rb

@@ -0,0 +1,61 @@
+module Middleman
+  module Sitemap
+    # Base app resource that inherits from Sitemap Resource.
+    #
+    class AppResource < Resource
+      def self.find_by_klass(klass, app)
+        app.sitemap.resources.detect do |res|
+          res.is_a?(self) && res.locals[:klass].name == klass.name
+        end
+      end
+
+      def self.find_by_path(path, app)
+        app.sitemap.resources.detect do |res|
+          res.is_a?(self) && res.source_file.to_s == path.to_s
+        end
+      end
+
+      # Get class for this child app.
+      #
+      # @return [Class] class for the child app
+      #
+      def klass
+        locals[:klass]
+      end
+
+      def title
+        locals[:title] || path.to_s.titleize
+      end
+
+      def description
+        str = locals[:description].to_s
+        locals[:description] = str.gsub(/^#{str.scan(/^[ \t]+(?=\S)/).min}/, '')
+      end
+
+      def update_locals(key, val)
+        locals[key.to_sym] = val
+      end
+
+      def routes
+        locals[:routes] || []
+      end
+
+      def html_description
+        return locals[:html_description] if locals[:html_description]
+        html = Tilt['markdown'].new { description }.render(self)
+        locals[:html_description] = html
+      end
+
+      def render(opts = {}, locs = {})
+        md   = metadata
+        locs = md[:locals].deep_merge(locs)
+        opts = md[:options].deep_merge(opts)
+        locs[:current_path] ||= destination_path
+
+        layout  = "layouts/#{opts.delete(:layout)}"
+        context = @app.template_context_class.new(@app, locs, opts)
+        context.render :middleman, layout, opts.merge(locals: locs)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: middleman-apps
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Nikhil Gupta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-10 00:00:00.000000000 Z
+date: 2017-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman-core
@@ -77,37 +77,75 @@ files:
 - ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
-- LICENSE.txt
+- LICENSE
 - README.md
 - Rakefile
-- features/activation.feature
-- features/build.feature
-- features/child_app.feature
-- features/complex_app.feature
-- features/directory_indexes.feature
-- features/not_found_rack.feature
-- features/not_found_server.feature
+- features/e_asset_hash.feature
+- features/e_directory_indexes.feature
+- features/e_relative_assets.feature
+- features/f_code_reloading.feature
+- features/f_metadata.feature
+- features/f_not_found.feature
+- features/f_options.feature
+- features/step_definitions/capybara_steps.rb
+- features/step_definitions/mechanize_steps.rb
 - features/step_definitions/rack_app_steps.rb
+- features/support/aruba.rb
 - features/support/env.rb
-- features/verbose.feature
-- fixtures/complex-app/apps/awesome_api.rb
-- fixtures/complex-app/apps/child_app.rb
-- fixtures/complex-app/apps/test_app.rb
-- fixtures/complex-app/build/error.html
-- fixtures/complex-app/build/index.html
-- fixtures/complex-app/config.rb
-- fixtures/complex-app/source/index.html.erb
-- fixtures/simple-app/apps/test_app.rb
-- fixtures/simple-app/build/error.html
-- fixtures/simple-app/build/index.html
-- fixtures/simple-app/config.rb
-- fixtures/simple-app/source/index.html.erb
+- features/support/helpers.rb
+- features/support/mechanize.rb
+- features/support/poltegeist.rb
+- features/v_activating.feature
+- features/v_building.feature
+- features/v_inheriting_from.feature
+- fixtures/asset_hash/apps/ignored_app.rb
+- fixtures/asset_hash/apps/test_app.rb
+- fixtures/asset_hash/config.rb
+- fixtures/asset_hash/source/error.html.erb
+- fixtures/asset_hash/source/index.html.erb
+- fixtures/asset_hash/source/layouts/layout.erb
+- fixtures/asset_hash/source/layouts/page.erb
+- fixtures/asset_hash/source/stylesheets/style.css.scss.erb
+- fixtures/dir_index/apps/ignored_app.rb
+- fixtures/dir_index/apps/test_app.rb
+- fixtures/dir_index/config.rb
+- fixtures/dir_index/source/index.html.erb
+- fixtures/mount_path/apps/test_app.rb
+- fixtures/mount_path/config.rb
+- fixtures/mount_path/source/index.html.erb
+- fixtures/real_world/apps/awesome_api.rb
+- fixtures/real_world/apps/child_app.rb
+- fixtures/real_world/apps/ignored_app.rb
+- fixtures/real_world/apps/no_namespace.rb
+- fixtures/real_world/apps/test_app.rb
+- fixtures/real_world/config.rb
+- fixtures/real_world/source/apps.html.erb
+- fixtures/real_world/source/custom.html.erb
+- fixtures/real_world/source/index.html.erb
+- fixtures/real_world/source/layouts/_partial.erb
+- fixtures/real_world/source/layouts/layout.erb
+- fixtures/real_world/source/layouts/page.erb
+- fixtures/real_world/source/layouts/test.html.markdown.erb
+- fixtures/relative_assets/apps/ignored_app.rb
+- fixtures/relative_assets/apps/test_app.rb
+- fixtures/relative_assets/config.rb
+- fixtures/relative_assets/source/error.html.erb
+- fixtures/relative_assets/source/index.html.erb
+- fixtures/relative_assets/source/layouts/layout.erb
+- fixtures/relative_assets/source/layouts/page.erb
+- fixtures/relative_assets/source/stylesheets/style.css.scss.erb
+- fixtures/simple/apps/ignored_app.rb
+- fixtures/simple/apps/test_app.rb
+- fixtures/simple/config.rb
+- fixtures/simple/source/index.html.erb
 - lib/middleman.rb
 - lib/middleman/apps.rb
 - lib/middleman/apps/base.rb
 - lib/middleman/apps/extension.rb
 - lib/middleman/apps/rack_contrib.rb
 - lib/middleman/apps/version.rb
+- lib/middleman/sitemap/app_collection.rb
+- lib/middleman/sitemap/app_resource.rb
 - middleman-apps.gemspec
 homepage: https://github.com/nikhgupta/middleman-apps
 licenses: []
@@ -133,13 +171,21 @@ signing_key:
 specification_version: 4
 summary: Middleman extension to run dynamic pages using Sinatra
 test_files:
-- features/activation.feature
-- features/build.feature
-- features/child_app.feature
-- features/complex_app.feature
-- features/directory_indexes.feature
-- features/not_found_rack.feature
-- features/not_found_server.feature
+- features/e_asset_hash.feature
+- features/e_directory_indexes.feature
+- features/e_relative_assets.feature
+- features/f_code_reloading.feature
+- features/f_metadata.feature
+- features/f_not_found.feature
+- features/f_options.feature
+- features/step_definitions/capybara_steps.rb
+- features/step_definitions/mechanize_steps.rb
 - features/step_definitions/rack_app_steps.rb
+- features/support/aruba.rb
 - features/support/env.rb
-- features/verbose.feature
+- features/support/helpers.rb
+- features/support/mechanize.rb
+- features/support/poltegeist.rb
+- features/v_activating.feature
+- features/v_building.feature
+- features/v_inheriting_from.feature

data/features/activation.feature

@@ -1,53 +0,0 @@
-Feature: Activating MiddlemanApps
-
-  Scenario: Without `middleman-apps`
-    Given a fixture app "simple-app"
-    And a file named "config.rb" with:
-      """
-      """
-    And the Server is running at "simple-app"
-    When I go to "/"
-    Then I should see "<h1>Middleman</h1>"
-    When I go to "/test-app"
-    Then the status code should be "404"
-    And  I should see "<h1>File Not Found</h1>"
-
-  Scenario: Without `middleman-apps` with Rack
-    Given a fixture app "simple-app"
-    And a file named "config.rb" with:
-      """
-      require 'sinatra'
-      require_relative 'apps/test_app'
-      map("/test-app") { run TestApp }
-      """
-    And the Server is running at "simple-app"
-    When I go to "/"
-    Then I should see "<h1>Middleman</h1>"
-    When I go to "/test-app"
-    Then I should see "fail"
-    When I go to "/test-app/?test=1"
-    Then I should see "pass"
-
-  Scenario: With `middleman-apps`
-    Given a fixture app "simple-app"
-    And a file named "config.rb" with:
-      """
-      activate :apps
-      """
-    And the Server is running at "simple-app"
-    When I go to "/"
-    Then I should see "<h1>Middleman</h1>"
-    When I go to "/test-app"
-    Then I should see "fail"
-    When I go to "/test-app/?test=1"
-    Then I should see "pass"
-
-  Scenario: Adds a `config.ru`
-    Given a fixture app "simple-app"
-    Then the file "config.ru" should not exist
-    Given a file named "config.rb" with:
-      """
-      activate :apps
-      """
-    And the Server is running at "simple-app"
-    Then the file "config.ru" should exist

data/features/build.feature

@@ -1,20 +0,0 @@
-Feature: Built app
-
-  Scenario: Builds successfully
-    Given a successfully built app at "simple-app"
-    Then the file "config.ru" should exist
-    And  the file "build/index.html" should exist
-    And  the file "build/apps/test_app.rb" should not exist
-
-  Scenario: Running built app
-    Given a fixture app "simple-app"
-    And   app is running with config:
-          """
-          activate :apps
-          """
-    When  I go to "/"
-    Then  I should see "<h1>Middleman</h1>"
-    When  I go to "/test-app"
-    Then  I should see "fail"
-    When  I go to "/test-app?test=1"
-    Then  I should see "pass"

data/features/child_app.feature

@@ -1,18 +0,0 @@
-Feature: 404 error pages for Child apps
-
-  Scenario: Custom 404 response from child app
-    Given a fixture app "complex-app"
-      And a file named "source/custom.html.erb" with:
-          """
-          <h2><%= 404 %> Custom Not Found!</h2>
-          """
-      And app is running with config:
-          """
-          activate :apps, not_found: "custom.html", namespace: :complex_app
-          """
-    When I go to "/child-app"
-    Then I should see "hello"
-    When I go to "/child-app/unknown"
-    Then the status code should be "404"
-    And  I should see "<h2>404 Custom Not Found!</h2>"
-

data/features/complex_app.feature

@@ -1,66 +0,0 @@
-Feature: Real world JSON API example
-
-  Scenario: Allows namespacing applications
-    Given a fixture app "complex-app"
-      And app is running with config:
-          """
-          activate :apps, namespace: "ComplexApp::SomeNamespace"
-          """
-    When I go to "/test-app?test=1"
-    Then the status code should be "200"
-    And  I should see "pass"
-
-  Scenario: Allows namespacing applications via underscored module path
-    Given a fixture app "complex-app"
-      And app is running with config:
-          """
-          activate :apps, namespace: "complex_app/some_namespace"
-          """
-    When I go to "/test-app?test=1"
-    Then the status code should be "200"
-    And  I should see "pass"
-
-  Scenario: Ignores modular apps that have no direct mapping
-    Given a fixture app "complex-app"
-      And app is running with config:
-          """
-          activate :apps, namespace: "other_namespacee"
-          """
-    When I go to "/test-app?test=1"
-    Then the status code should be "404"
-
-  Scenario: Allows specifying Application Name
-    Given a fixture app "complex-app"
-      And app is running with config:
-          """
-          activate :apps, namespace: :complex_app,
-            map: { child_app: "/some-other-path/abcd" }
-          """
-    When I go to "/some-other-path/abcd"
-    Then the status code should be "200"
-    And  I should see "hello"
-
-  Scenario: Allows specifying URL path for application
-    Given a fixture app "complex-app"
-      And app is running with config:
-          """
-          activate :apps,
-            namespace: 'complex_app/some_namespace',
-            map: {
-              test_app: 'test',
-              awesome_api: {
-                url: 'api',
-                class: "OtherNamespace::AwesomeAPI"
-              }
-            }
-          """
-    When I go to "/test-app?test=1"
-    Then the status code should be "404"
-    When I go to "/test?test=1"
-    Then the status code should be "200"
-    And  I should see "pass"
-    When I go to "/awesome-api/ping"
-    Then the status code should be "404"
-    When I go to "/api/ping"
-    Then the status code should be "200"
-    And  I should see "pong"

data/features/not_found_server.feature

@@ -1,8 +0,0 @@
-Feature: 404 error pages with Middleman Preview Server
-
-  Scenario: Fixed 404 response with Server
-    Given a fixture app "simple-app"
-    And the Server is running at "simple-app"
-    When I go to "/unknown-app"
-    Then the status code should be "404"
-    And  I should see "<h1>File Not Found</h1>"

data/features/verbose.feature

@@ -1,23 +0,0 @@
-Feature: Verbose mode
-
-  Scenario: Display list of child apps which were ignored
-    Given a fixture app "complex-app"
-      And I overwrite the file named "config.rb" with:
-          """
-          activate :apps, verbose: true
-          """
-      And I run `middleman build --verbose`
-      And the aruba exit timeout is 2 seconds
-      And I run `rackup -p 17283` in background
-     Then the output should match:
-          """
-          Ignored child app:.*apps\/awesome_api\.rb
-          """
-     And  the output should match:
-          """
-          Ignored child app:.*apps\/test_app\.rb
-          """
-     And  the output should match:
-          """
-          Ignored child app:.*apps\/child_app\.rb
-          """

data/fixtures/complex-app/apps/awesome_api.rb

@@ -1,11 +0,0 @@
-require 'sinatra'
-
-module OtherNamespace
-  # Child app that tests specifying a specific namespace/class
-  # for a single URL endpoint
-  class AwesomeAPI < Sinatra::Base
-    get '/ping' do
-      'pong'
-    end
-  end
-end

data/fixtures/complex-app/build/error.html

@@ -1 +0,0 @@
-<h1>Error!!</h1>

data/fixtures/complex-app/config.rb

@@ -1 +0,0 @@
-activate :apps # , not_found: 'error.html'

data/fixtures/simple-app/apps/test_app.rb

@@ -1,8 +0,0 @@
-require 'sinatra'
-
-# Test application fixture
-class TestApp < Sinatra::Base
-  get '/' do
-    params[:test] ? 'pass' : 'fail'
-  end
-end

data/fixtures/simple-app/build/error.html

@@ -1 +0,0 @@
-<h1>Error!!</h1>

data/fixtures/simple-app/config.rb

@@ -1 +0,0 @@
-activate :apps # , not_found: 'error.html'