sculptor 0.0.1 → 0.0.2

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZjFkOGFjZWVlYWVlODI1OWYwYzVhYzNiYzZiNzI4NjE4YzRjODZkMw==
-  data.tar.gz: !binary |-
-    NmYzYTM2Yjg3ZDlkMDJiYTYwMDVhNmRlODYwZGVlMjg4ZmJhOWI0ZA==
+SHA1:
+  metadata.gz: e8892ec5089d558ff641359ff69733d048e314ef
+  data.tar.gz: 67d2fc8ee63e505b326ac3d7e656b7fc92ad4156
 SHA512:
-  metadata.gz: !binary |-
-    NmNjYzgxNTc0NGEwMWM1MjM2Zjg1NzAxNWEyZmY4YTBhODdmMDQzMjI1NTY4
-    NDVmOWI3NDU3Yjc3NmUyM2QyNTdjMDM2M2NmNjI5ZjU0Yjk0OWJiMWZjMTdl
-    NmQ4OWZjMGE5Y2QwMjZiYjQ5OTVmN2E4MTI2MTJlZWI0OTEzMmY=
-  data.tar.gz: !binary |-
-    N2FjOWVlYzhjNjNmZmIyZGI2ZWNmODJjNzIwNzU1YTNkNDc5MjE0ZDM4MWQ4
-    MDM1OTllNzVkYmQ1NmJlZmQxN2JhNDBmMmY2MzdkN2IyZTNlOGI3YjNlNmU1
-    Yzg3ZGNhMjNlNjFjMGRhZTA0OTI2MTI1YWFlOThmM2FmN2Y5Njg=
+  metadata.gz: b88e45b635671467b563f201163d0a65e99315347f3044e0b3615a9eec54d6e6a25933850adf7cefc96fab4e7acf3e59d1ae9c259b37e74d42cdafe12ca481d5
+  data.tar.gz: 5080d19bf694387499df1975c8f889aa04d1b2d45fbbdc5b3657bd1226aff5ac7d9470edf8bfb87536d05e0870bb604dec41021c34474af420fd1ec0ce7927ea

data/.editorconfig

@@ -0,0 +1,10 @@
+# editorconfig.org
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

data/Gemfile

@@ -1,4 +1,3 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in sculptor.gemspec
 gemspec

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'cucumber' do
+  watch(%r{^features/.+\.feature$})
+  watch(%r{^features/support/.+$})                      { 'features' }
+  watch(%r{^features/step_definitions/(.+)_steps\.rb$}) { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'features' }
+end

data/Rakefile

@@ -1 +1,2 @@
+require 'rspec/core/rake_task'
 require "bundler/gem_tasks"

data/bin/sculptor

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'middleman-core/profiling'
+if ARGV.include? '--profile'
+  Middleman::Profiling.profiler = Middleman::Profiling::RubyProfProfiler.new
+end
+Middleman::Profiling.start
+
+require "sculptor/load_paths"
+Sculptor.setup_load_paths
+
+require 'sculptor/cli'
+
+Sculptor::CLI::Base.start

data/features/create.feature

@@ -0,0 +1,36 @@
+Feature: Run `create` command
+  In order to create new models
+
+  Scenario: Create a new model scaffold
+    Given I run `sculptor create test` interactively
+    Then I wait for output to contain "Creating model: source/test"
+    And I wait for output to contain "Title"
+    Then I hit enter
+    And I wait for output to contain "Description"
+    Then I hit enter
+    And I wait for output to contain "Stylesheet"
+    Then I hit enter
+    And I wait for output to contain "Include data?"
+    Then I type "n"
+    And the exit status should be 0
+    Then the output should contain "create"
+
+  Scenario: Create a new model scaffold and set meta data
+    Given I run `sculptor create test` interactively
+    Then I wait for output to contain "Creating model: source/test"
+    And I wait for output to contain "Title"
+    Then I type "Hello World"
+    And I wait for output to contain "Description"
+    Then I type "My model description"
+    And I wait for output to contain "Stylesheet"
+    Then I type "styles"
+    And I wait for output to contain "Include data?"
+    Then I type "y"
+    And the exit status should be 0
+    Then the output should contain "create"
+    And a directory named "source/test" should exist
+    Then the file "source/test/test.html.slim" should contain "Hello World"
+    And the file "source/test/test.html.slim" should contain "My model description"
+    And the file "source/test/index.html.slim" should contain "'partials/glyptotheque/model-index', locals: { dir: '/test' }"
+    And the file "source/test/test.yaml" should contain "hello: World"
+    And the file "source/test/styles.scss" should contain "@import 'bourbon'"

data/features/step_definitions/custom.rb

@@ -0,0 +1,3 @@
+Then /^I hit enter$/ do
+  type("\r")
+end

data/features/support/setup.rb

@@ -0,0 +1,5 @@
+require 'aruba/cucumber'
+
+Before do
+  @aruba_timeout_seconds = 5
+end

data/lib/sculptor/cli/create.rb

@@ -0,0 +1,54 @@
+module Sculptor::CLI
+  class Create < Thor
+    include Thor::Actions
+
+    check_unknown_options!
+
+    namespace :create
+
+    def self.source_root
+      File.join(File.dirname(__FILE__), '..', 'templates', 'model')
+    end
+
+    def self.exit_on_failure?
+      true
+    end
+
+    desc 'create NAME', 'Create new model NAME'
+    def create(name)
+      model_path = "source/#{name}"
+
+      say(set_color("Creating model: ", :yellow) + set_color(model_path, :white, :bold))
+
+      is_subdir = name.split('/').count > 1
+      parent_path = is_subdir ? model_path.split('/')[0..-2].join('/') : model_path
+
+      @name = name
+      @title = options[:title] || ask('Title: ')
+      @description = options[:desc] || ask('Description: ')
+      @stylesheet = ask('Stylesheet: ')
+      @dir = is_subdir ? name.split('/')[0..-2].join('/') : name
+
+      @has_data = if yes?('Include data?')
+        @model_name = name.split('/').last
+        template 'data', (is_subdir ? model_path : File.join(model_path, name)) + '.yaml'
+      end
+
+      template 'template', (is_subdir ? model_path : File.join(model_path, name)) + '.html.slim'
+
+      has_index = File.file?(File.join(parent_path, 'index.html.slim'))
+      unless has_index
+        template 'index-template', (is_subdir ? File.join(parent_path, 'index') : File.join(model_path, 'index')) + '.html.slim'
+      end
+
+      unless @stylesheet.empty?
+        stylesheet_path = is_subdir ? Pathname(model_path).join("../#{@stylesheet}").to_s : File.join(model_path, "#{@stylesheet}")
+        template 'styles', "#{stylesheet_path}.scss" unless File.file? "#{stylesheet_path}.scss"
+      end
+    end
+
+    Base.map(
+      'c'      => 'create'
+    )
+  end
+end

data/lib/sculptor/cli/init.rb

@@ -0,0 +1,73 @@
+require 'sculptor/templates'
+
+# Copied from `middleman-core/lib/middleman-core/cli/init.rb`
+# in order to modify default template
+module Middleman::Cli
+  # A thor task for creating new projects
+  class Init < Thor
+    check_unknown_options!
+
+    namespace :init
+
+    desc 'init NAME [options]', 'Create new project NAME'
+    available_templates = ::Middleman::Templates.registered.keys.join(', ')
+    method_option 'template',
+                  aliases: '-T',
+                  default: 'glyptotheque',
+                  desc: "Use a project template: #{available_templates}"
+    method_option 'css_dir',
+      # :default => "stylesheets",
+                  desc: 'The path to the css files'
+    method_option 'js_dir',
+      # :default => "javascripts",
+                  desc: 'The path to the javascript files'
+    method_option 'images_dir',
+      # :default => "images",
+                  desc: 'The path to the image files'
+    method_option 'rack',
+                  type: :boolean,
+                  default: false,
+                  desc: 'Include a config.ru file'
+    method_option 'skip-gemfile',
+                  type: :boolean,
+                  default: false,
+                  desc: "Don't create a Gemfile"
+    method_option 'skip-bundle',
+                  type: :boolean,
+                  aliases: '-B',
+                  default: false,
+                  desc: "Don't run bundle install"
+    method_option 'skip-git',
+                  type: :boolean,
+                  default: false,
+                  desc: 'Skip Git ignores and keeps'
+    # The init task
+    # @param [String] name
+    def init(name='.')
+      key = options[:template].to_sym
+      unless ::Middleman::Templates.registered.key?(key)
+        raise Thor::Error, "Unknown project template '#{key}'"
+      end
+
+      thor_group = ::Middleman::Templates.registered[key]
+      thor_group.new([name], options).invoke_all
+    end
+  end
+
+  def self.exit_on_failure?
+    true
+  end
+
+  # Map "i", "new" and "n" to "init"
+  Base.map(
+             'i'   => 'init',
+             'new' => 'init',
+             'n'   => 'init'
+  )
+end
+
+module Sculptor::CLI
+  class Init < Thor
+    register(Middleman::Cli::Init, :init, "init NAME", "Create new project NAME")
+  end
+end

data/lib/sculptor/cli/server.rb

@@ -0,0 +1,5 @@
+module Sculptor::CLI
+  class Server < Middleman::Cli::Server
+    register(Middleman::Cli::Server, :server, "server", "Run Middleman preview server")
+  end
+end

data/lib/sculptor/cli.rb

@@ -0,0 +1,52 @@
+require 'thor'
+require 'middleman-core/version'
+require 'middleman-core/cli'
+
+module Sculptor
+  module CLI
+    class Base < Middleman::Cli::Base
+      desc 'version', 'Show version'
+      def version
+        say "Sculptor #{Sculptor::VERSION} (Middleman #{Middleman::VERSION})"
+      end
+
+      def help(meth=nil, subcommand=false)
+        if meth && !self.respond_to?(meth)
+          klass, task = Thor::Util.find_class_and_task_by_namespace("#{meth}:#{meth}")
+          klass.start(['-h', task].compact, shell: shell)
+        else
+          list = []
+          Thor::Util.thor_classes_in(Sculptor::CLI).each do |thor_class|
+            list += thor_class.printable_tasks(false)
+          end
+          list.sort! { |a, b| a[0] <=> b[0] }
+
+          shell.say "\n"
+          shell.print_table(list, ident: 2, truncate: true)
+          shell.say
+        end
+      end
+
+      # Intercept missing methods and search subtasks for them
+      # @param [Symbol] meth
+      def method_missing(meth, *args)
+        meth = meth.to_s
+        meth = self.class.map[meth] if self.class.map.key?(meth)
+
+        klass, task = Thor::Util.find_class_and_task_by_namespace("#{meth}:#{meth}")
+
+        if klass.nil?
+          raise Thor::Error, "There's no '#{meth}' command for Sculptor. Try 'sculptor help' for a list of commands."
+        else
+          args.unshift(task) if task
+          klass.start(args, shell: shell)
+        end
+      end
+    end
+  end
+end
+
+require 'sculptor/version'
+require 'sculptor/cli/create'
+require 'sculptor/cli/init'
+require 'sculptor/cli/server'

data/lib/sculptor/extensions/data_loaders.rb

@@ -0,0 +1,53 @@
+class Middleman::Extensions::DataLoaders < ::Middleman::Extension
+  def initialize(app, options_hash={})
+    super
+
+    require 'open-uri'
+  end
+
+  helpers do
+    def pwd
+      File.dirname(File.expand_path(current_page.path, root))
+    end
+
+    def load_data(path, options = nil)
+      resource = if path.start_with? 'http'
+        load_remote_data(path, options)
+      else
+        sitemap.find_resource_by_path(relative_dir(current_page.path, path).to_s)
+      end
+
+      raise "#{path} not found" unless resource
+
+      if ['.yaml', '.yml'].include? resource.ext
+        yaml = resource.render
+      elsif resource.ext == '.json'
+        json = resource.render
+      end
+
+      if json
+        JSON.parse(resource.render)
+      elsif yaml
+        YAML.load(resource.render)
+      end
+    end
+
+    private
+
+    def load_remote_data(url, options)
+      begin
+        if(options)
+          resource = open(url, http_basic_authentication: [options[:user], options[:password]])
+        else
+          resource = open(url)
+        end
+      rescue
+        raise "Couldn't load the remote: #{url}."
+      end
+      {
+        ext: '.json',
+        render: resource.read
+      }
+    end
+  end
+end

data/lib/sculptor/extensions/model.rb

@@ -0,0 +1,54 @@
+class Middleman::Extensions::Model < ::Middleman::Extension
+  def initialize(app, options_hash={})
+    super
+
+    require 'open-uri'
+    require 'nokogiri'
+  end
+
+  helpers do
+    # Requires one of `&block` or `url + selector`
+    # Parameters:
+    # * `title` (optional) - Model title
+    # * `description` (optional) - Model description
+    # * `component_url` (optional) - Model URL
+    # * `component_selector` (required if `url` is provided)
+    # * `&block` (optional)
+    def model(options={}, &block)
+      [:title, :description].each { |k| options[k] ||= nil }
+
+      if block_given?
+        html = capture_html(&block)
+        metadata = options
+      elsif options[:component]
+        component_path = "components/#{options[:component]}"
+        resource = sitemap.find_resource_by_path("#{component_path}.html")
+        metadata = resource.metadata.page
+        html = resource.render
+      elsif options[:component_url] && options[:component_selector]
+        metadata = options
+        doc = Nokogiri::HTML(open(options[:component_url]))
+        result = doc.css(options[:component_selector])
+        if result.empty?
+          raise "Selector `#{options[:component_selector]}` not found in remote location`#{options[:component_url]}`"
+        end
+        html = result.to_html
+      else
+        raise "Model `#{options[:title]}`: No `component` of HTML block was given"
+      end
+
+      options.reverse_merge!(metadata.symbolize_keys!)
+      options[:html] = html
+
+      options[:source_code] = html unless options.has_key? :source_code
+      options[:source_type] ||= 'html'
+
+      partial('partials/glyptotheque/model', locals: options)
+    end
+
+    def model_source(type, &block)
+      source_code = capture_html(&block)
+      partial('partials/glyptotheque/model-source', locals: { source_type: type, source_code: source_code })
+    end
+  end
+end

data/lib/sculptor/extensions/resource_helpers.rb

@@ -0,0 +1,61 @@
+class Middleman::Extensions::ResourceHelpers < ::Middleman::Extension
+  helpers do
+    def include_stylesheets(stylesheets)
+      return unless stylesheets && stylesheets.is_a?(Array) && stylesheets.length > 0
+      stylesheets.map { |s|
+        include_stylesheet(s)
+      }.join("\n")
+    end
+
+    def include_stylesheet(stylesheet)
+      return if stylesheet.empty?
+      stylesheet_link_tag(relative_dir(current_page.path, stylesheet)) + "\n"
+    end
+
+    def include_javascripts(javascripts)
+      return unless javascripts && javascripts.is_a?(Array) && javascripts.length > 0
+      javascripts.map { |j|
+        path = j.start_with?('http') ? j : relative_dir(current_page.path, j)
+        javascript_include_tag(path) + "\n"
+      }.join("\n")
+    end
+
+    # Constructs path relative to base path (first argument)
+    def relative_dir(path, *args)
+      relative_path = args ? args.join('/') : ''
+      Pathname(path).dirname.join(relative_path)
+    end
+
+    def resource_file(resource)
+      resource.path.split('/').last.gsub(resource.ext, '')
+    end
+
+    def resource_dir(resource)
+      resource.url.split('/').last
+    end
+
+    def subpages_for(dir, ext = 'html', exclude_indexes: false)
+      resources = sitemap.resources
+        .select {|r| r.ext == ".#{ext}"}                # Select files only HTML files
+        .reject {|r| r.data.hidden}                     # reject hidden (Front matter)
+        .select {|r| r.url.start_with?(dir)}            # Select files in the given dir
+        .sort_by(&:url)                                 # Sort by URL (ensures indexes first)
+        .reject {|r| r.url == dir}                      # Exclude main directory index
+
+      if exclude_indexes
+        resources = resources.reject {|r| r.directory_index? } # Exclude all directory indexes
+      end
+
+      resources.reject {|r| r.path.end_with? ("-full#{r.ext}")} # Ignore proxied '-full' mode pages
+    end
+
+    # Use in layouts, in templates either Frontmatter or this method can be used
+    def append_class(block_name, appended_classes='')
+      current_page_classes = current_page.data[block_name] || ''
+      existing_classes_a = current_page_classes.split(' ')
+      appended_classes_a = appended_classes.split(' ')
+      classes = existing_classes_a.concat(appended_classes_a).reverse.join(' ')
+      content_for(block_name, classes)
+    end
+  end
+end

data/lib/sculptor/extensions.rb

@@ -0,0 +1,8 @@
+require 'sculptor/extensions/model'
+Middleman::Extensions::Model.register
+
+require 'sculptor/extensions/data_loaders'
+Middleman::Extensions::DataLoaders.register
+
+require 'sculptor/extensions/resource_helpers'
+Middleman::Extensions::ResourceHelpers.register

data/lib/sculptor/load_paths.rb

@@ -0,0 +1,53 @@
+# Core Pathname library used for traversal
+require 'pathname'
+
+module Sculptor
+  class << self
+    def setup_load_paths
+      @_is_setup ||= begin
+
+        # Only look for config.rb if MM_ROOT isn't set
+        if !ENV['MM_ROOT'] && found_path = locate_root
+          ENV['MM_ROOT'] = found_path
+        end
+
+        is_bundler_setup = false
+
+        # If we've found the root, try to setup Bundler
+        if ENV['MM_ROOT']
+
+          root_gemfile = File.expand_path('Gemfile', ENV['MM_ROOT'])
+          ENV['BUNDLE_GEMFILE'] ||= root_gemfile
+
+          unless File.exist?(ENV['BUNDLE_GEMFILE'])
+            git_gemfile = Pathname.new(__FILE__).expand_path.parent.parent.parent + 'Gemfile'
+            ENV['BUNDLE_GEMFILE'] = git_gemfile.to_s
+          end
+
+          if File.exist?(ENV['BUNDLE_GEMFILE'])
+            is_bundler_setup = true
+            require 'bundler/setup'
+          end
+        end
+
+        # Automatically discover extensions in RubyGems
+        require 'middleman-core/extensions'
+
+        if is_bundler_setup
+          Bundler.require
+        else
+          ::Middleman.load_extensions_in_path
+        end
+
+        true
+      end
+    end
+
+    # Recursive method to find config.rb
+    def locate_root(cwd=Pathname.new(Dir.pwd))
+      return cwd.to_s if (cwd + 'config.rb').exist?
+      return false if cwd.root?
+      locate_root(cwd.parent)
+    end
+  end
+end

data/lib/sculptor/method_missing.rb

@@ -0,0 +1,6 @@
+# Allow keys dot syntax
+class Hash
+  def method_missing(sym, *args)
+    fetch(sym) { fetch(sym.to_s) { super } }
+  end
+end

data/lib/sculptor/templates/glyptotheque/.bowerrc

@@ -0,0 +1,3 @@
+{
+  "directory" : "bower_components"
+}

data/lib/sculptor/templates/glyptotheque/.editorconfig

@@ -0,0 +1,10 @@
+# editorconfig.org
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

data/lib/sculptor/templates/glyptotheque/.gitignore

@@ -0,0 +1 @@
+bower_components

data/lib/sculptor/templates/glyptotheque/Gemfile.tt

@@ -0,0 +1,22 @@
+source 'https://rubygems.org'
+
+gem 'sculptor'
+gem 'middleman'
+gem 'nokogiri'
+gem 'middleman-pry'
+gem 'sass', '~>3.3'
+gem 'compass', github: 'chriseppstein/compass'
+gem 'sass-css-importer'
+gem 'slim'
+gem 'bourbon'
+gem 'neat'
+
+gem 'middleman-syntax', github: 'middleman/middleman-syntax'
+
+# Custom LiveReload (animate transitions)
+gem 'rack-livereload',
+  github: 'tyom/rack-livereload',
+  branch: 'livereload-animate'
+gem 'middleman-livereload',
+  github: 'tyom/middleman-livereload',
+  branch: 'animate-transitions'

data/lib/sculptor/templates/glyptotheque/bower.json

@@ -0,0 +1,11 @@
+{
+  "name": "sculptor",
+  "version": "0.0.1",
+  "private": "true",
+  "dependencies": {
+    "normalize.css": "*",
+    "angular": "~1.2.16",
+    "lodash": "*",
+    "mousetrap": "~1.4.6"
+  }
+}