docks_app 0.0.2 → 0.0.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MzU4M2JmNDY3NjNkZWVjZWNmN2MxYTZiMjE4MWFiNzM4MjU0MWY0Nw==
+    MTZkNGY3ZjlkOTJlNTA4OGUwOWNhNzA0OWZmNjdjYjQ5ZDc5YjgzYg==
   data.tar.gz: !binary |-
-    ZDgwZDQ4MWYyM2I5ZGRkNDQ5YzQ2Y2IyZmNjMGRmM2NlN2E0MGQ3NA==
+    OWRlMjYyMDllNzM3YTdlMjI2ZjhjMWIzOGE4ZDA4YjliMGZmYTJiOA==
 SHA512:
   metadata.gz: !binary |-
-    OGE5OWJiOGQxZDFiZDM4Y2FlOWU4ZmZlNTQzOTk4YjY2MGUzNzNjZTBiMDM2
-    MjQ1OWE4NDM2OTFlNmIwZDI2YWRiM2MxMjg4OWJjMDJlNDQzNDIwNzIzZTNk
-    ZjRhMmRlZWFkNDk2OTcxYWMwNmE5ZjU3MDliNTU0YWU1NzAyOGE=
+    MTk0NTk4YWQ1NDM2ODU2OTlkNmVlM2Q1MmM0MzExYTRkNDAxZTZlOTgwZDlh
+    OWY0YjdjNzAwOWFjODgzMzM4MDJiYjc5MDJhYWMyOTAwMTZjZWUyYTcxZTdm
+    MDBjNTQ4YmI1ZTAwM2IzZWY3YTZmOThlNjUwODA2YzhiYzVlMGQ=
   data.tar.gz: !binary |-
-    OTdhYjU4NDgyNDI3NTM3Y2IxMmVlZjY2OTQyNjZjZjg4YWI2OGJmZTc1NTdj
-    M2ExN2M3Y2Q0ZGJhYTc3NDczMWRkZmYwODZiMDUwMTY1ZWI5ZTkxZDhjMTZh
-    MjAxYzJjODMzZmUyNjI1YTJiOWE0MjQ5NGZmZTM4MmQ4NGI1MmY=
+    MGRlNjcwZjZlZWU3ZDFjNzIxNzNkYTVkYWUzOTk1MzU3YjlmNzQ3ZDk3MzVh
+    NmI5NTlkNjI4MjhmOWMwY2I5OTUzYmUwOTJhZDJlNjkyNjY5ZDZjOWM5ZTRi
+    ZWQ4ZTQwM2JhMmEwODBlZWMzYzRkNDg3NGRiNTViNTVjMzc4YzY=

data/config/json/docks_config.json

@@ -25,8 +25,6 @@
   // all pattern files will be nested inside this directory.
   "mount_at": {{{mount_at}}},
 
-  "use_theme_assets": {{{use_theme_assets}}},
-
   // The name of the Github repo for this project. This can either be the URL or
   // in the form `<username>/<repo>`. The default theme uses this option, if
   // passed, to provide links to create issue and view source for your pattern

data/config/ruby/docks_config.rb

@@ -26,8 +26,6 @@ Docks.configure do |config|
   # all pattern files will be nested inside this directory.
   config.mount_at = {{{mount_at}}}
 
-  config.use_theme_assets = {{{use_theme_assets}}}
-
   # The name of the Github repo for this project. This can either be the URL or
   # in the form `<username>/<repo>`. The default theme uses this option, if
   # passed, to provide links to create issue and view source for your pattern

data/config/yaml/docks_config.yml

@@ -25,8 +25,6 @@ templates: {{{templates}}}
 # all pattern files will be nested inside this directory.
 mount_at: {{{mount_at}}}
 
-use_theme_assets: {{{use_theme_assets}}}
-
 # The name of the Github repo for this project. This can either be the URL or
 # in the form `<username>/<repo>`. The default theme uses this option, if
 # passed, to provide links to create issue and view source for your pattern

data/lib/docks/build.rb

@@ -20,7 +20,7 @@ module Docks
       def method_missing(meth)
         if options.respond_to?(meth)
           present(options.send(meth), meth)
-        elsif (result = default_config.instance_variable_get("@#{meth}".to_sym))
+        elsif !(result = default_config.instance_variable_get("@#{meth}".to_sym)).nil?
           present(result, meth)
         else
           super
@@ -104,10 +104,15 @@ module Docks
     end
 
     def self.setup(options)
-      @options = OpenStruct.new(options)
+      @options = options = OpenStruct.new(options)
       @assets_dir = File.join(Dir.pwd, Docks::ASSETS_DIR)
       FileUtils.mkdir_p(@assets_dir)
 
+      if options.theme
+        theme = Themes.for(options.theme)
+        theme.configure(Docks.config) if theme && theme.respond_to?(:configure)
+      end
+
       if Dir[CONFIG_FILE].empty?
         setup_config
       end

data/lib/docks/configuration.rb

@@ -16,8 +16,7 @@ module Docks
       :sources,
       :destination,
       :cache_location,
-      :templates,
-      :helpers
+      :templates
     ]
 
     # Key details — these are required
@@ -28,7 +27,7 @@ module Docks
 
     # Random assortment of other stuff
     attr_accessor :github_repo, :mount_at, :helpers, :compiled_assets,
-                  :naming_convention, :pattern_id, :paginate, :use_theme_assets
+                  :naming_convention, :pattern_id, :paginate
 
     # Stateful stuff
     attr_reader :configured
@@ -68,6 +67,10 @@ module Docks
       !!@paginate
     end
 
+    def has_theme?
+      !!@theme
+    end
+
     def pattern_id(*args)
       Docks.pattern_id(*args)
     end
@@ -104,6 +107,16 @@ module Docks
       yield Parser
     end
 
+    def helpers
+      @helpers.map do |helper|
+        if helper.kind_of?(String)
+          make_path_absolute(helper)
+        else
+          helper
+        end
+      end
+    end
+
     ROOT_DEPENDENT_PATHS.each do |path|
       define_method(path) do
         paths = instance_variable_get("@#{path.to_s}".to_sym)
@@ -125,12 +138,11 @@ module Docks
       ]
       @compiled_assets = []
       @github_repo = ""
-      @paginate = :pattern
       @naming_convention = NamingConventions::BEM.instance
       @helpers = []
 
-      @theme = Themes.for("API")
-      @use_theme_assets = true
+      @theme = false
+      @paginate = false
 
       @root = Pathname.pwd
       @cache_location = ".#{Docks::Cache::DIR}"
@@ -186,7 +198,7 @@ module Docks
     end
 
     if File.extname(configurer) =~ /rb/
-      self.class_eval(File.read(configurer))
+      self.class_eval(File.read(configurer), configurer, 0)
     else
       Languages.register_bundled_languages
       language = Languages.language_for(configurer)

data/lib/docks/helpers.rb

@@ -8,6 +8,7 @@ module Docks
       return unless renderer.respond_to?(:helpers)
 
       renderer.helpers(*bundled_helpers)
+      renderer.helpers(*Docks.config.theme.helpers) if Docks.config.has_theme?
       renderer.helpers(*Docks.config.helpers)
       renderer
     end

data/lib/docks/helpers/path_helper.rb

@@ -34,13 +34,13 @@ module Docks
       end
 
       def docks_stylesheet(stylesheet = :main)
-        return unless Docks.config.use_theme_assets
+        return unless Docks.config.has_theme?
         postfix = (stylesheet.to_sym == :main ? "" : "-#{stylesheet.to_s}")
         stylesheet_link_tag("docks#{postfix}.css")
       end
 
       def docks_javascript(script = :main)
-        return unless Docks.config.use_theme_assets
+        return unless Docks.config.has_theme?
         postfix = (script.to_sym == :main ? "" : "_#{script.to_s}")
         javascript_include_tag("docks#{postfix}.js")
       end

data/lib/docks/helpers/render_helper.rb

@@ -58,29 +58,16 @@ module Docks
       end
 
       def render_description(description, options = {})
-        @example_count ||= 0
         description.gsub! /(href\s*=\s*['"])@link\s([^'"]*)(.)/ do |match|
           "#{$1}#{docks_path($2, options)}#{$3}"
         end
 
-        render(layout: false, inline: description.gsub(/<fenced_code_block[^>]*>(.*?)<\/fenced_code_block>/m) { |match|
-          @example_count += 1
-          code = $1.dup
-          has_demo = match.include?("data-has-demo")
-          language = match.match(/data\-language=["']([^'"]*)/).captures.first
-
-          code_details = []
-          code_details << { code: code, language: language, label: "Helper" }
-
-          if has_demo
-            code_details << { code: render(inline: code, layout: false), language: "html", label: "Markup" }
-          end
+        render(layout: false, inline: render_description_with_theme(description, options))
+      end
 
-          docks_code_block code: code_details,
-                           hideable?: has_demo,
-                           id: "code-block--example-#{@example_count}",
-                           demo?: has_demo
-        })
+      # To be (optionally) overriden in themes
+      def render_description_with_theme(description, options = {})
+        description
       end
     end
   end

data/lib/docks/renderers/common_features/helperable.rb

@@ -9,7 +9,7 @@ module Docks
             if helper.kind_of?(Module)
               self.send(:extend, helper)
             elsif File.exists?(helper)
-              load_helpers.module_eval(File.read(helper))
+              load_helpers.module_eval(File.read(helper), helper, 0)
             end
           end
 

data/lib/docks/version.rb

@@ -1,3 +1,3 @@
 module Docks
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/lib/build_spec.rb

@@ -69,6 +69,13 @@ describe Docks::Builder do
       expect(File.read(copied_file)).to eq "# foo"
     end
 
+    it "preconfigures with the specified theme" do
+      default_options[:theme] = "API"
+      subject.setup(default_options)
+      expect(Docks.config.theme).to be_a Docks::Themes::API
+      expect(Docks.config.paginate).to eq "pattern"
+    end
+
     it "configures the pattern library with the new config file" do
       expect(Docks).to receive(:configure).with no_args
       subject.setup(default_options)
@@ -183,7 +190,7 @@ describe Docks::Builder do
 
   describe ".parse" do
     before :each do
-      Docks.configure_with(root: empty_dir, library_assets: "")
+      Docks.configure_with(root: empty_dir)
     end
 
     it "adds the parse function to the top-level Docks namespace" do
@@ -228,7 +235,7 @@ describe Docks::Builder do
       FileUtils.mkdir_p(existing_dir)
       FileUtils.cd(existing_dir)
       Docks::Templates.send(:clean)
-      Docks.configure_with(destination: destination, root: existing_dir)
+      Docks.configure_with(destination: destination, root: existing_dir, theme: "API", paginate: "pattern")
 
       default_options[:script_language] = "coffeescript"
       subject.setup(default_options)

data/spec/lib/configuration_spec.rb

@@ -49,8 +49,7 @@ describe Docks::Configuration do
     expect(subject.templates).to eq subject.root + "#{Docks::ASSETS_DIR}/templates"
     expect(subject.asset_folders).to eq OpenStruct.new(styles: "styles", scripts: "scripts")
     expect(subject.mount_at).to eq "pattern-library"
-    expect(subject.theme).to eq Docks::Themes::API.instance
-    expect(subject.use_theme_assets).to be true
+    expect(subject.theme).to be false
   end
 
   describe "#root=" do

data/spec/lib/helpers/path_helper_spec.rb

@@ -11,6 +11,7 @@ describe Docks::Helpers::Path do
   before(:each) do
     Docks::Languages.register_bundled_languages
     Docks.current_render_destination = Docks.config.destination + "baz/index.html"
+    Docks.configure_with(theme: "API")
     subject.instance_variable_set(:@pattern_library, pattern_library)
     subject.instance_variable_set(:@pattern, pattern)
   end
@@ -178,8 +179,8 @@ describe Docks::Helpers::Path do
       expect(subject.docks_stylesheet(:demo)).to eq subject.stylesheet_link_tag("docks-demo.css")
     end
 
-    it "returns nothing when config.use_theme_assets is false" do
-      Docks.configure_with(use_theme_assets: false)
+    it "returns nothing when there is no theme" do
+      Docks.configure_with(theme: false)
       expect(subject.docks_stylesheet).to be nil
     end
   end
@@ -193,8 +194,8 @@ describe Docks::Helpers::Path do
       expect(subject.docks_javascript(:demo)).to eq subject.javascript_include_tag("docks_demo.js")
     end
 
-    it "returns nothing when config.use_theme_assets is false" do
-      Docks.configure_with(use_theme_assets: false)
+    it "returns nothing when there is no theme" do
+      Docks.configure_with(theme: false)
       expect(subject.docks_javascript).to be nil
     end
   end

data/spec/lib/helpers/render_helper_spec.rb

@@ -102,57 +102,12 @@ describe Docks::Helpers::Render do
         expect(pattern.description).to eq "foo bar <a href='/pattern-library/baz'>baz</a>"
       end
 
-      context "when there is a code block" do
-        before(:each) do
-          allow(subject).to receive(:render) { |opts| opts[:inline] }
-        end
-
-        let(:code_block) { "<div>\n  Foo\n</div>" }
-        let(:language) { "html" }
-        let(:markdown) { Redcarpet::Markdown.new(Docks::Markdown::Renderer, fenced_code_blocks: true) }
-
-        it "renders a code block" do
-          pattern.description = markdown.render(markdown_code_block)
-          expect(subject).to receive(:docks_code_block) do |options|
-            expect(options[:hideable?]).to be false
-            expect(options[:demo?]).to be false
-
-            code = options[:code]
-            expect(code.length).to be 1
-            expect(code.first[:code].strip).to eq code_block
-            expect(code.first[:language]).to eq language
-          end
-
-          subject.render_everything
-        end
-
-        it "renders a code block with the a demo" do
-          pattern.description = markdown.render(markdown_code_block(with_demo: true))
-          expect(subject).to receive(:docks_code_block) do |options|
-            expect(options[:hideable?]).to be true
-            expect(options[:demo?]).to be true
-          end
-
-          subject.render_everything
-        end
-
-        it "adds a unique ID to each demo" do
-          pattern.description = markdown.render(markdown_code_block * 2)
-
-          ids = []
-          expect(subject).to receive(:docks_code_block).twice do |options|
-            ids.push(options[:id])
-          end
-
-          subject.render_everything
-          expect(ids).to eq ids.uniq
-        end
-
-        private
-
-        def markdown_code_block(options = {})
-          options.fetch(:with_demo, false) ? "```#{language}_demo\n#{code_block}\n```" : "```#{language}\n#{code_block}\n```\n"
-        end
+      it "calls the theme's render description helper" do
+        allow(subject).to receive(:render) { |opts| opts[:inline] }
+        pattern.description = "foo bar"
+        expect(subject).to receive(:render_description_with_theme).with("foo bar", hash_including(:language)).and_return("baz qux")
+        subject.render_everything
+        expect(pattern.description).to eq "baz qux"
       end
     end
   end

data/spec/lib/helpers_spec.rb

@@ -1,4 +1,5 @@
 require "spec_helper"
+require "docks_theme_api"
 
 describe Docks::Helpers do
   describe ".add_helpers_to" do
@@ -17,8 +18,24 @@ describe Docks::Helpers do
       end
     end
 
+    it "adds all theme helpers" do
+      theme = Docks::Themes::API.instance
+      helpers = []
+
+      Docks.configure_with(theme: theme)
+      allow(renderer).to receive(:helpers) do |*args|
+        helpers = helpers.concat(args)
+      end
+
+      described_class.add_helpers_to(renderer)
+
+      Docks.config.theme.helpers.each do |helper|
+        expect(helpers).to include helper
+      end
+    end
+
     it "adds any user-configured helpers" do
-      Docks.configure_with helpers: ["foo.txt", "bar.txt"]
+      Docks.configure_with(helpers: ["foo.txt", "bar.txt"])
 
       helpers = []
       allow(renderer).to receive(:helpers) do |*args|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: docks_app
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Chris Sauve
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-20 00:00:00.000000000 Z
+date: 2015-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redcarpet