web_blocks 2.0.0.dev

data/demo/Blockfile.rb

@@ -0,0 +1,67 @@
+# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+#
+# BLOCKSFILE EXAMPLE
+#
+# This file is intended to showcase some of the common features available to Blocksfile.rb. In production, it is likely
+# that helpers will be used to cut down on boilerplate. Additionally, Blocksfile.rb is pure Ruby, so it supports being
+# split into a number of files for organizational purposes.
+#
+# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+
+#
+# CUSTOM BLOCK DEFINITIONS
+#
+# Ideally, frameworks and tools should include Blockfile.rb; however, this will not always be the case. In some cases,
+# frameworks may not explicitly support WebBlocks (even though, through this syntax, WebBlocks can support them), and,
+# in others, it may be advantageous simply to download a build product.
+#
+
+# Adding a jQuery block as jQuery does not include a Blockfile.rb defining it
+block 'jquery', :path => 'bower_components/jquery/dist' do
+  js_file 'jquery.js'
+end
+
+# Adding a dependency on the jquery block for efx to include jquery if including efx
+block 'efx' do
+  dependency framework.route 'jquery'
+end
+
+#
+# BLOCK INCLUSIONS
+#
+# This registration defines which blocks will be included in the build.
+#
+
+include 'WebBlocks-visibility', 'breakpoint'
+include 'WebBlocks-visibility', 'accessible'
+
+include 'efx', 'driver', 'accordion'
+include 'efx', 'driver', 'tabs'
+include 'efx', 'driver', 'toggle'
+
+# also valid would be either of these to include all efx drivers:
+#   include 'efx', 'driver'
+#   include 'efx'
+
+
+
+#
+# CUSTOM SOURCES
+#
+# This defines an 'src' block intended to for application-specific sources.
+#
+
+block 'WebBlocks', :path => Pathname.new(__FILE__).parent + 'src' do
+
+  block 'config', :path => 'config' do
+
+    block 'WebBlocks-breakpoints' do
+
+      scss_file 'WebBlocks-breakpoints.scss'
+      reverse_dependency framework.route 'WebBlocks-breakpoints'
+
+    end
+
+  end
+
+end

data/demo/bower.json

@@ -0,0 +1,8 @@
+{
+    "name": "WebBlocks",
+    "version": "2.0.0",
+    "dependencies": {
+        "WebBlocks-visibility": "WebBlocks/block-visibility",
+        "efx": "ebollens/efx"
+    }
+}

data/demo/package.json

@@ -0,0 +1,5 @@
+{
+    "dependencies": {
+        "bower":">=1.2.8"
+    }
+}

data/demo/src/config/WebBlocks-breakpoints.scss

@@ -0,0 +1,9 @@
+//$breakpoint-xxsmall:        360px !default;
+//$breakpoint-xsmall:         480px !default;
+//$breakpoint-small:          640px !default;
+//$breakpoint-medium-small:   768px !default;
+//$breakpoint-medium:         900px !default;
+//$breakpoint-medium-large:   1024px !default;
+//$breakpoint-large:          1200px !default;
+//$breakpoint-xlarge:         1500px !default;
+//$breakpoint-xxlarge:        1800px !default;

data/lib/web_blocks/framework.rb

@@ -0,0 +1,20 @@
+module WebBlocks
+  module Framework
+
+    def framework options = {}, &block
+
+      # Lazy-load to avoid cyclical require loop with 'web_blocks/structure/framework'
+      require 'web_blocks/structure/framework'
+      @@framework ||= ::WebBlocks::Structure::Framework.new 'framework'
+
+      # Set options, if any were passed
+      options.each { |name, value| @@framework.set name, value }
+
+      # Evaluate block in context of WebBlocks::Structure::Framework singleton represented by this method
+      @@framework.instance_eval(&block) if block_given?
+      @@framework
+
+    end
+
+  end
+end

data/lib/web_blocks/manager/bower.rb

@@ -0,0 +1,106 @@
+require 'fileutils'
+require 'ostruct'
+require 'json'
+require 'ruby-bower'
+
+module WebBlocks
+  module Manager
+    class Bower
+
+      attr_reader :base_path
+      attr_reader :bowerfile_path
+      attr_reader :cache_path
+      attr_reader :components_path
+      attr_reader :registry_cache_path
+
+      def initialize base_path
+        @base_path = base_path
+        @bowerfile_path = base_path + 'bower.json'
+        @cache_path = base_path + '.blocks/cache/bower'
+        @registry_cache_path = @cache_path + 'registry.json'
+        @components_path = base_path + 'bower_components'
+        @registry = nil
+      end
+
+      def installed?
+        File.exists? @components_path
+      end
+
+      def clean_registry_cache!
+        FileUtils.rm_f registry_cache_path
+      end
+
+      def clean_components_cache!
+        ::Bower.context.call "bower.commands.cache.clean"
+      end
+
+      def prune_components!
+        ::Bower.context.call "bower.commands.prune"
+      end
+
+      def update!
+        ::Bower.context.call "bower.commands.update"
+      end
+
+      def clean_update!
+        clean_registry_cache!
+        clean_components_cache!
+        prune_components!
+        update!
+      end
+
+      def compute_registry
+        {
+          'name' => compute_registry_name,
+          'components' => compute_registry_components
+        }
+      end
+
+      def compute_registry_name
+        definition = JSON.parse File.read bowerfile_path
+        definition['name']
+      end
+
+      def compute_registry_components
+        components = {}
+        dependencies = ::Bower.context.call("bower.commands.list", :sources => true)['dependencies'].values
+        while dependencies.length > 0
+          dependency = dependencies.pop
+          components[dependency['pkgMeta']['name']] = dependency['canonicalDir']
+          dependency['dependencies'].values.each do |dependency|
+            dependencies << dependency unless components.has_key? dependency['pkgMeta']['name']
+          end
+        end
+        components
+      end
+
+      def has_registry_cache?
+        File.exists? registry_cache_path
+      end
+
+      def get_registry_cache
+        JSON.parse File.read registry_cache_path
+      end
+
+      def save_registry_cache registry
+        FileUtils.mkdir_p cache_path
+        File.open(registry_cache_path, 'w') {|f| f.write registry.to_json }
+      end
+
+      def get_registry
+        if has_registry_cache?
+          registry = get_registry_cache
+        else
+          registry = compute_registry
+          save_registry_cache registry
+        end
+        registry
+      end
+
+      def registry
+        @registry ||= OpenStruct.new get_registry
+      end
+
+    end
+  end
+end

data/lib/web_blocks/manager/builder/base.rb

@@ -0,0 +1,31 @@
+module WebBlocks
+  module Manager
+    module Builder
+      class Base
+
+        attr_reader :log
+        attr_reader :task
+
+        def initialize task
+
+          @task = task
+          @log = task.log.scope 'BUILD'
+
+        end
+
+        def execute!
+
+          yield if block_given?
+
+        end
+
+        def save!
+
+          yield task.base_path + task.root.get(:build_dir) if block_given?
+
+        end
+
+      end
+    end
+  end
+end

data/lib/web_blocks/manager/builder/js.rb

@@ -0,0 +1,54 @@
+require 'fileutils'
+require 'web_blocks/manager/builder/base'
+require 'web_blocks/strategy/link/js'
+
+module WebBlocks
+  module Manager
+    module Builder
+      class Js < Base
+
+        attr_reader :link_strategy
+
+        def initialize task
+
+          super task
+
+          @link_strategy = WebBlocks::Strategy::Link::Js.new(task)
+
+        end
+
+        def execute!
+
+          super do
+
+            link_strategy.execute!
+
+          end
+
+        end
+
+        def save!
+
+          super do |build_path|
+
+            log.info do
+
+              js_build_path = build_path + task.root.get(:js_build_dir)
+              FileUtils.mkdir_p js_build_path
+
+              source_path = link_strategy.product_path
+              product_path = js_build_path + source_path.basename
+              FileUtils.copy source_path, product_path
+
+              "Saved JS build #{product_path}"
+
+            end
+
+          end
+
+        end
+
+      end
+    end
+  end
+end

data/lib/web_blocks/manager/builder/scss.rb

@@ -0,0 +1,57 @@
+require 'web_blocks/manager/builder/base'
+require 'web_blocks/strategy/link/scss'
+require 'web_blocks/strategy/compile/scss'
+
+module WebBlocks
+  module Manager
+    module Builder
+      class Scss < Base
+
+        attr_reader :link_strategy
+        attr_reader :compile_strategy
+
+        def initialize task
+
+          super task
+
+          @link_strategy = WebBlocks::Strategy::Link::Scss.new(task)
+          @compile_strategy = WebBlocks::Strategy::Compile::Scss.new(task)
+
+        end
+
+        def execute!
+
+          super do
+
+            link_strategy.execute!
+            compile_strategy.execute!
+
+          end
+
+        end
+
+        def save!
+
+          super do |build_path|
+
+            log.info do
+
+              css_build_path = build_path + task.root.get(:css_build_dir)
+              FileUtils.mkdir_p css_build_path
+
+              source_path = compile_strategy.product_path
+              product_path = css_build_path + source_path.basename
+              FileUtils.copy source_path, product_path
+
+              "Saved CSS build #{product_path}"
+
+            end
+
+          end
+
+        end
+
+      end
+    end
+  end
+end

data/lib/web_blocks/manager/parallel_builder.rb

@@ -0,0 +1,52 @@
+require 'web_blocks/support/parallel_jobs'
+require 'web_blocks/manager/builder/js'
+require 'web_blocks/manager/builder/scss'
+
+module WebBlocks
+  module Manager
+    class ParallelBuilder
+
+      MAP = {
+        :scss => {
+          :scope_name => 'SCSS',
+          :strategy => WebBlocks::Manager::Builder::Scss
+        },
+        :js => { :scope_name => 'JS', :strategy => WebBlocks::Manager::Builder::Js }
+      }
+
+      attr_reader :task
+      attr_reader :log
+
+      def initialize task
+
+        @task = task
+        @log = task.log
+        @parallel_jobs = WebBlocks::Support::ParallelJobs.new
+        @started_strategies = []
+
+      end
+
+      def start type
+
+        strategy = MAP[type][:strategy].new(task)
+
+        @parallel_jobs.start do
+          log.scope MAP[type][:scope_name] do |log|
+            strategy.execute!
+          end
+        end
+
+        @started_strategies << strategy
+
+      end
+
+      def save_when_done!
+
+        @parallel_jobs.wait_for_complete!
+        @started_strategies.each { |strategy| strategy.save! }
+
+      end
+
+    end
+  end
+end

data/lib/web_blocks/product/concat_file/js.rb

@@ -0,0 +1,15 @@
+require 'web_blocks/product/concat_file/raw'
+
+module WebBlocks
+  module Product
+    module ConcatFile
+      class Js < Raw
+
+        def content_for file
+          ";#{super file};"
+        end
+
+      end
+    end
+  end
+end

data/lib/web_blocks/product/concat_file/raw.rb

@@ -0,0 +1,33 @@
+module WebBlocks
+  module Product
+    module ConcatFile
+      class Raw
+
+        attr_reader :path
+
+        def initialize path
+          @path = Pathname.new(path)
+          @files = []
+        end
+
+        def push file
+          @files << file
+        end
+
+        def content_for file
+          IO.read file.resolved_path.to_s
+        end
+
+        def save!
+          FileUtils.mkdir_p @path.parent
+          File.open(@path, 'w') do |f|
+            @files.each do |file|
+              f.puts "#{content_for file}"
+            end
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/web_blocks/product/concat_file/scss.rb

@@ -0,0 +1,21 @@
+require 'web_blocks/product/concat_file/raw'
+
+module WebBlocks
+  module Product
+    module ConcatFile
+      class Scss < Raw
+
+        def content_for file
+          file_path = file.resolved_path.to_s.gsub(/"/, '\\"')
+          if file_path.match /\.css$/
+            file_path = "CSS:#{file_path.gsub(/\.css$/, '')}" # this syntax is supported by 'sass-css-importer' plugin
+          elsif file_path.match /\.scss$/
+            file_path.gsub!(/\.scss$/, '') # allow it to resolve with or without underscore by dropping extension
+          end
+          "@import \"#{file_path}\";"
+        end
+
+      end
+    end
+  end
+end

data/lib/web_blocks/strategy/compile/scss.rb

@@ -0,0 +1,90 @@
+require 'compass'
+require 'sass/plugin'
+require 'sass-css-importer'
+
+module WebBlocks
+  module Strategy
+    module Compile
+      class Scss
+
+        attr_reader :task
+        attr_reader :log
+        attr_reader :workspace_path
+        attr_reader :cache_path
+        attr_reader :product_path
+        attr_reader :source_path
+
+        def initialize task
+
+          @task = task
+          @log = task.log.scope 'SCSS - Compile'
+          @workspace_path = task.base_path + '.blocks/workspace'
+          @cache_path = task.base_path + '.blocks/cache/sass'
+          @source_path = @workspace_path + 'scss/blocks.scss'
+          @product_path = @workspace_path + 'css/blocks.css'
+
+        end
+
+        def execute!
+
+          log.info { "Starting" }
+
+          output = StringIO.new
+
+          with_compass_io output do
+            configure_compass!
+            compass_compile!
+          end
+
+          output.rewind
+          output.each_line { |line| log.debug("Compass"){ line.to_s.gsub(/\n/,'') } }
+
+          log.info { "Finished" }
+
+        end
+
+        def configure_compass!
+
+          Compass.add_configuration({
+              :project_path => workspace_path,
+              :sass_path => 'scss',
+              :css_path => 'css',
+              :cache_path => cache_path
+            },
+            'blocks'
+          )
+
+        end
+
+        def compass_compile!
+
+          FileUtils.mkdir_p product_path.parent
+          Compass.compiler.compile source_path.to_s, product_path.to_s
+
+        end
+
+        def with_compass_io io
+
+          alias_mapping = {
+            :color => Proc.new { |c| "" },
+            :log => Proc.new { |msg| io.puts msg }
+          }
+
+          alias_mapping.each do |method, proc|
+            Compass::Logger.send :alias_method, "___#{method}", method
+            Compass::Logger.send :define_method, method, &proc
+          end
+
+          yield
+
+          alias_mapping.keys.each do |method|
+            Compass::Logger.send :alias_method, method, "___#{method}"
+            Compass::Logger.send :remove_method, "___#{method}"
+          end
+
+        end
+
+      end
+    end
+  end
+end

data/lib/web_blocks/strategy/link/base.rb

@@ -0,0 +1,51 @@
+module WebBlocks
+  module Strategy
+    module Link
+      class Base
+
+        attr_reader :task
+        attr_reader :log
+        attr_reader :linker_file
+        attr_accessor :files_to_link
+
+        def initialize task
+
+          @task = task
+          @log = task.log.scope 'Link'
+          @linker_file = make_linker_file
+          @files_to_link = compute_files_to_link
+
+        end
+
+        def execute!
+
+          log.info { "Starting" }
+
+          files_to_link.each do |file|
+            log.debug do
+              linker_file.push file
+              "Linked #{file.resolved_path}"
+            end
+          end
+
+          log.debug do
+            linker_file.save!
+            "Saved #{linker_file.path}"
+          end
+
+          log.info { "Finished" }
+
+        end
+
+        def make_linker_file
+          raise NoMethodError, "undefined method `make_linker_file!' for #{self}"
+        end
+
+        def compute_files_to_link
+          []
+        end
+
+      end
+    end
+  end
+end

data/lib/web_blocks/strategy/link/js.rb

@@ -0,0 +1,30 @@
+require 'web_blocks/strategy/link/base'
+require 'web_blocks/structure/js_file'
+require 'web_blocks/product/concat_file/js'
+
+module WebBlocks
+  module Strategy
+    module Link
+      class Js < Base
+
+        def initialize task
+          super task
+          @log = task.log.scope 'JS - Link'
+        end
+
+        def product_path
+          task.base_path + '.blocks/workspace/js/blocks.js'
+        end
+
+        def make_linker_file
+          ::WebBlocks::Product::ConcatFile::Js.new product_path
+        end
+
+        def compute_files_to_link
+          task.root.get_file_load_order(::WebBlocks::Structure::JsFile)
+        end
+
+      end
+    end
+  end
+end

data/lib/web_blocks/strategy/link/scss.rb

@@ -0,0 +1,30 @@
+require 'web_blocks/strategy/link/base'
+require 'web_blocks/structure/scss_file'
+require 'web_blocks/product/concat_file/scss'
+
+module WebBlocks
+  module Strategy
+    module Link
+      class Scss < Base
+
+        def initialize task
+          super task
+          @log = task.log.scope 'SCSS - Link'
+        end
+
+        def product_path
+          task.base_path + '.blocks/workspace/scss/blocks.scss'
+        end
+
+        def make_linker_file
+          ::WebBlocks::Product::ConcatFile::Scss.new product_path
+        end
+
+        def compute_files_to_link
+          task.root.get_file_load_order(::WebBlocks::Structure::ScssFile)
+        end
+
+      end
+    end
+  end
+end