parcels 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 658277fafd37674b7c9be8026a325a2cb907f89c
+  data.tar.gz: a1f74856053841ef8fb0573d246b64a712544c49
+SHA512:
+  metadata.gz: a589bcc70801b68c35d4d3b16e2a07e7863a199e211a96ca50f171dac1ea623215ed034084f8efcd7845b827565275eb51d832bd6a8a00bcf8f17f90d6606fcb
+  data.tar.gz: 3005a5072e9d47179a0946ce166626cf6db502f9c99fe1f74b87014b57b2776369c1d04427a7f85be903a3d309d7002ca8a7abdad50d3327f8373343d90d8dd8

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec-local

@@ -0,0 +1,4 @@
+--format documentation
+--color
+--order random
+-r helpers/global_helper

data/.travis.yml

@@ -0,0 +1,54 @@
+language:   ruby
+rvm:
+    - "1.8.7"
+    - "1.9.3"
+    - "2.0.0"
+    - "2.1.5"
+    - "jruby-1.7.17"
+env:
+    - PARCELS_SPECS_SPROCKETS_VERSION=2.11.3 PARCELS_SPECS_RAILS_VERSION=4.1.7
+    - PARCELS_SPECS_SPROCKETS_VERSION=2.11.3 PARCELS_SPECS_RAILS_VERSION=4.0.11
+    - PARCELS_SPECS_SPROCKETS_VERSION=2.2.3 PARCELS_SPECS_RAILS_VERSION=3.2.21
+    - PARCELS_SPECS_SPROCKETS_VERSION=2.0.5 PARCELS_SPECS_RAILS_VERSION=3.1.12
+before_script:
+    - export JRUBY_OPTS="$JRUBY_OPTS -J-Xmx384m -J-Xms384m -J-Xss2048k"
+matrix:
+    exclude:
+        # Rails 4.x doesn't support Ruby 1.8.7
+        -   rvm: 1.8.7
+            env: PARCELS_SPECS_SPROCKETS_VERSION=2.11.3 PARCELS_SPECS_RAILS_VERSION=4.1.7
+        -   rvm: 1.8.7
+            env: PARCELS_SPECS_SPROCKETS_VERSION=2.11.3 PARCELS_SPECS_RAILS_VERSION=4.0.11
+    allow_failures:
+        # 2014-12-14 ageweke -- Unfortunately, there appears to be a bug in Ruby 1.8.7 that conflicts with Sass and
+        # is biting us here. The symptom is that our out-of-process Rails server suddenly crashes, causing various
+        # Rails specs to fail with 'connection refused' or 'end of file' (when reading from the socket) kinds of
+        # errors. If you look in log/rails-server.log in the Rails server directory, you'll see something like
+        # this:
+        #
+        # : [BUG] gc_sweep(): unknown data type 0x0(0x109cd5fa0)
+        # ruby 1.8.7 (2013-06-27 patchlevel 374) [i686-darwin14.0.0]
+        #
+        # There are multiple sources
+        # (https://stackoverflow.com/questions/3844794/server-failure-bug-gc-sweep-unknown-data-type-0x0,
+        #  https://github.com/sass/sass/issues/581, etc.)
+        # indicating that other people have hit this repeatedly, and we don't seem to ever see it on other Ruby
+        # versions.
+        #
+        # Since 1.8.7 is very old as of this writing, while I'd like to keep officially supporting it, I'm going to
+        # keep running these tests but monitor them manually, to see if anything *other* than the Rails specs
+        # starts failing.
+        -   rvm: 1.8.7
+            env: PARCELS_SPECS_SPROCKETS_VERSION=2.2.3 PARCELS_SPECS_RAILS_VERSION=3.2.21
+        -   rvm: 1.8.7
+            env: PARCELS_SPECS_SPROCKETS_VERSION=2.0.5 PARCELS_SPECS_RAILS_VERSION=3.1.12
+        # 2014-12-14 ageweke -- Just like Fortitude, getting Travis to actually do reliable JRuby specs seems to be
+        # impossible, sadly.
+        -   rvm: jruby-1.7.17
+            env: PARCELS_SPECS_SPROCKETS_VERSION=2.11.3 PARCELS_SPECS_RAILS_VERSION=4.1.7
+        -   rvm: jruby-1.7.17
+            env: PARCELS_SPECS_SPROCKETS_VERSION=2.11.3 PARCELS_SPECS_RAILS_VERSION=4.0.11
+        -   rvm: jruby-1.7.17
+            env: PARCELS_SPECS_SPROCKETS_VERSION=2.2.3 PARCELS_SPECS_RAILS_VERSION=3.2.21
+        -   rvm: jruby-1.7.17
+            env: PARCELS_SPECS_SPROCKETS_VERSION=2.0.5 PARCELS_SPECS_RAILS_VERSION=3.1.12

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in parcels.gemspec
+gemspec
+gem 'oop_rails_server', :path => '../oop_rails_server'
+gem 'fortitude', :path => '../fortitude'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Andrew Geweke
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# Parcels
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'parcels'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install parcels
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/parcels/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/parcels/dependency_parcel_list.rb

@@ -0,0 +1,50 @@
+require 'tsort'
+
+module Parcels
+  class DependencyParcelList
+    def initialize
+      @tag_to_child_tag_map = { }
+      @parcel_to_tag_map = { }
+      @tag_to_parcel_map = { }
+
+      @loose_parcels = [ ]
+    end
+
+    def tsort_each_node(&block)
+      parcel_to_tag_map.keys.each(&block)
+    end
+
+    def tsort_each_child(parcel, &block)
+      tag = parcel_to_tag_map[parcel]
+      child_tags = tag_to_child_tag_map[tag] || [ ]
+      child_parcels = child_tags.map { |t| tag_to_parcel_map[t] }.compact
+
+      child_parcels.each(&block)
+    end
+
+    def add_parcels!(parcels)
+      parcels.each do |parcel|
+        if parcel.tag
+          parcel_to_tag_map[parcel] = parcel.tag
+          tag_to_parcel_map[parcel.tag] = parcel
+
+          parcel.tags_that_must_come_before.each do |tag_that_must_come_before|
+            tag_to_child_tag_map[tag_that_must_come_before] ||= [ ]
+            tag_to_child_tag_map[tag_that_must_come_before] << parcel.tag
+          end
+        else
+          loose_parcels << parcel
+        end
+      end
+    end
+
+    def parcels_in_order
+      tsort.reverse # tsort puts children before parents; we want the exact opposite
+    end
+
+    include TSort
+
+    private
+    attr_reader :tag_to_child_tag_map, :parcel_to_tag_map, :tag_to_parcel_map, :loose_parcels
+  end
+end

data/lib/parcels/environment.rb

@@ -0,0 +1,60 @@
+require 'parcels/widget_tree'
+
+module Parcels
+  class Environment
+    attr_reader :sprockets_environment
+
+    delegate :root, :to => :sprockets_environment
+
+    def initialize(sprockets_environment)
+      @sprockets_environment = sprockets_environment
+      @widget_trees = [ ]
+
+      register_engines!
+    end
+
+    def is_underneath_root?(filename)
+      filename = File.expand_path(filename)
+      filename.length > root.length && filename[0..(root.length - 1)] == root
+    end
+
+    def add_widget_tree!(widget_tree_root)
+      widget_tree_root = File.expand_path(widget_tree_root, root)
+      widget_tree = widget_trees.detect { |wt| wt.root == widget_tree_root }
+
+      if (! widget_tree)
+        widget_tree = WidgetTree.new(self, widget_tree_root)
+        widget_trees << widget_tree
+      end
+
+      widget_tree.add_workaround_directory_to_sprockets!(sprockets_environment)
+    end
+
+    def widget_class_from_file(pathname)
+      ::Fortitude::Widget.widget_class_from_file(pathname, :root_dirs => widget_trees.map(&:root))
+    end
+
+    def create_and_add_all_workaround_directories!
+      # widget_trees.each do |widget_tree|
+      #   widget_tree.add_workaround_directory_to_sprockets!(sprockets_environment)
+      # end
+    end
+
+    def add_all_widgets_to!(sprockets_context, set_names)
+      widget_trees.each { |wt| wt.add_all_widgets_to_sprockets_context!(sprockets_context, set_names) }
+    end
+
+    private
+    attr_reader :widget_trees
+
+    def register_engines!
+      @engines_registered ||= begin
+        if ::Parcels.fortitude_available?
+          @sprockets_environment.register_engine '.rb', ::Parcels::Fortitude::WidgetEngine
+          @sprockets_environment.register_engine '.pcss', ::Parcels::Fortitude::AlongsideEngine
+        end
+        true
+      end
+    end
+  end
+end

data/lib/parcels/fortitude/alongside_engine.rb

@@ -0,0 +1,37 @@
+require 'tilt'
+
+module Parcels
+  module Fortitude
+    class AlongsideEngine < Tilt::Template
+      self.default_mime_type = 'text/css'
+
+      def self.engine_initialized?
+        true
+      end
+
+      def initialize_engine
+        require_template_library 'fortitude'
+      end
+
+      def prepare
+      end
+
+      def evaluate(context, locals, &block)
+        parcels_environment = context.environment.parcels
+        widget_file = ::Parcels::Utils::PathUtils.widget_class_file_for_alongside_file(context.pathname)
+
+        unless widget_file
+          raise Errno::ENOENT, "Somehow, we're being asked to render CSS from #{context.pathname.to_s.inspect}, but we can't find a Fortitude widget class next to that file"
+        end
+
+        widget_class = parcels_environment.widget_class_from_file(widget_file)
+
+        if widget_class
+          widget_class._parcels_widget_class_alongside_css(parcels_environment, context)
+        else
+          ""
+        end
+      end
+    end
+  end
+end

data/lib/parcels/fortitude/assets.rb

@@ -0,0 +1,212 @@
+require 'active_support'
+require 'active_support/concern'
+
+require 'parcels/fragments/css_fragment'
+
+require 'sass'
+
+module Parcels
+  module Fortitude
+    module Assets
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        def inherited(new_class)
+          super(new_class)
+
+          if respond_to?(:caller_locations, true) && false
+            locations = caller_locations(1, 1)
+            filename = locations.first.absolute_path
+            new_class._parcels_inherited_called_from(filename)
+          else
+            string = caller[0]
+            if string =~ /^([^:]+):\d+/
+              new_class._parcels_inherited_called_from($1)
+            else
+              raise "Parcels: #{new_class} inherited from #{self.name}, but caller string was unparseable: '#{string}'"
+            end
+          end
+        end
+
+        def _parcels_inherited_called_from(filename)
+          @_parcels_class_definition_files ||= [ ]
+          @_parcels_class_definition_files << filename
+        end
+
+        def _parcels_class_definition_files
+          @_parcels_class_definition_files ||= [ ]
+        end
+
+        def _parcels_widget_outer_element_classes
+          @_parcels_widget_outer_element_classes ||= begin
+            out = [ ]
+            out << _parcels_widget_outer_element_class if _parcels_wrapping_css_class_required?
+            out += superclass._parcels_widget_outer_element_classes if superclass.respond_to?(:parcels_enabled?) && superclass.parcels_enabled?
+            out
+          end
+        end
+
+        def _parcels_css_fragments
+          _parcels_alongside_css_fragments + _parcels_inline_css_fragments
+        end
+
+        def _parcels_widget_outer_element_class
+          @_parcels_widget_outer_element_class ||= begin
+            class_suffix = self.name.gsub('::', '__').underscore.gsub(/[^A-Za-z0-9_]/, '_')
+
+            "parcels_class__#{class_suffix}"
+          end
+        end
+
+        def _parcels_widget_class_css(parcels_environment, context)
+          ::Parcels::Fragments::CssFragment.to_css(parcels_environment, context, _parcels_css_fragments)
+        end
+
+        def _parcels_widget_class_inline_css(parcels_environment, context)
+          ::Parcels::Fragments::CssFragment.to_css(parcels_environment, context, _parcels_inline_css_fragments)
+        end
+
+        def _parcels_widget_class_alongside_css(parcels_environment, context)
+          ::Parcels::Fragments::CssFragment.to_css(parcels_environment, context, _parcels_alongside_css_fragments)
+        end
+
+        def _parcels_wrapping_css_class_required?
+          _parcels_css_fragments.detect { |f| f.wrapping_css_class_required? }
+        end
+
+        def _parcels_alongside_css_fragments
+          options = { :prefix => _parcels_get_css_prefix }.merge(_parcels_css_options)
+          _parcels_alongside_filenames.map do |filename|
+            if File.exist?(filename)
+              ::Parcels::Fragments::CssFragment.new(File.read(filename), self, filename, 1, options)
+            end
+          end.compact
+        end
+
+        def _parcels_alongside_filenames
+          out = [ ]
+
+          _parcels_class_definition_files.each do |filename|
+            filename = $1 if filename =~ /^(.*)\.rb$/i
+            out << "#{filename}.pcss"
+          end
+
+          out.select { |f| File.file?(f) }
+        end
+
+        def _parcels_add_wrapper_css_classes_to(attributes, wrapper_classes)
+          out = attributes || { }
+          key = out.key?('class') ? 'class' : :class
+          out[key] = Array(out[key]) + wrapper_classes
+          out
+        end
+
+        def _parcels_inline_css_fragments
+          @_parcels_inline_css_fragments ||= [ ]
+        end
+
+        def css_options(options)
+          raise ArgumentError, "You must pass a Hash to css_options, not: #{options.inspect}" unless options.kind_of?(Hash)
+          options.assert_valid_keys(:engines)
+
+          @_parcels_css_options = options
+        end
+
+        def _parcels_css_options
+          out = @_parcels_css_options
+          out ||= superclass._parcels_css_options if superclass.respond_to?(:_parcels_css_options)
+          out || { }
+        end
+
+        def css(*css_strings)
+          unless parcels_enabled?
+            klass = self
+            superclasses = all_fortitude_superclasses
+
+            raise %{Before using this Parcels method, you must first enable Parcels on this class. Simply
+call 'enable_parcels!', a class method, on the base widget class you want to enable -- typically, this
+is your base Fortitude widget class.
+
+This class is #{klass.name};
+you may want to enable Parcels on any of its Fortitude superclasses, which are:
+#{superclasses.map(&:name).join("\n")}}
+          end
+
+          options = { :prefix => _parcels_get_css_prefix }
+          options.merge!(css_strings.extract_options!)
+
+          caller_line = caller[0]
+          if caller_line =~ /^(.*)\s*:\s*(\d+)\s*:\s*in\s+/i
+            caller_file = $1
+            caller_line = Integer($2)
+          else
+            caller_file = caller_line
+            caller_line = nil
+          end
+
+          @_parcels_inline_css_fragments ||= [ ]
+          @_parcels_inline_css_fragments += css_strings.map do |css_string|
+            ::Parcels::Fragments::CssFragment.new(css_string, self, caller_file, caller_line, _parcels_css_options.merge(options))
+          end
+        end
+
+        def css_prefix(prefix = nil, &block)
+          if (prefix && block)
+            raise ArgumentError, "You can supply either a String or a block, but not both; you passed: #{prefix.inspect} and #{block.inspect}"
+          end
+
+          if (prefix != nil) && (! prefix.kind_of?(String))
+            raise ArgumentError, "Invalid prefix (must be a String, or nil): #{prefix.inspect}"
+          end
+
+          @_parcels_css_prefix = prefix || block
+        end
+
+        def parcels_sets(*set_names, &block)
+          if set_names.length > 0 && block
+            raise ArgumentError, "You can specify either a set name or a block, but not both; you passed: #{set_names.inspect} and #{block.inspect}"
+          end
+
+          if set_names == [ nil ]
+            @_parcels_sets = [ ]
+          else
+            @_parcels_sets = block || set_names.map(&:to_sym)
+          end
+        end
+
+        def _parcels_get_sets(defining_file_path)
+          _parcels_get_sets_for_class(self, defining_file_path)
+        end
+
+        def _parcels_get_sets_for_class(klass, defining_file_path)
+          if @_parcels_sets
+            out = @_parcels_sets
+            out = out.call(klass, defining_file_path) if out.respond_to?(:call)
+            out = Array(out).map(&:to_sym)
+            out
+          elsif superclass.respond_to?(:_parcels_get_sets_for_class)
+            superclass._parcels_get_sets_for_class(klass, defining_file_path)
+          else
+            [ ]
+          end
+        end
+
+        def _parcels_get_css_prefix
+          _parcels_get_css_prefix_for_class(self)
+        end
+
+        def _parcels_get_css_prefix_for_class(klass)
+          if @_parcels_css_prefix
+            out = @_parcels_css_prefix
+            out = out.call(klass) if out.respond_to?(:call)
+            out
+          elsif superclass.respond_to?(:_parcels_get_css_prefix_for_class)
+            superclass._parcels_get_css_prefix_for_class(klass)
+          else
+            nil
+          end
+        end
+      end
+    end
+  end
+end

data/lib/parcels/fortitude/enabling.rb

@@ -0,0 +1,72 @@
+require 'active_support'
+require 'active_support/concern'
+
+module Parcels
+  module Fortitude
+    module Enabling
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        def parcels_enabled?
+          out = false
+          out = true if superclass.respond_to?(:parcels_enabled?) && superclass.parcels_enabled?
+          out = true if @_parcels_enabled
+          out
+        end
+
+        def enable_parcels!
+          raise "Already enabled on #{self}!" if @_parcels_enabled
+
+          record_tag_emission true
+
+          @_parcels_tag_methods_module = Module.new
+          const_set(:ParcelsEnablingModule, @_parcels_tag_methods_module)
+          include @_parcels_tag_methods_module
+
+          _parcels_ensure_all_tag_methods_overridden!
+
+          @_parcels_enabled = true
+        end
+
+        def tags_changed!(tags)
+          super
+          _parcels_ensure_all_tag_methods_overridden! if parcels_enabled?
+        end
+
+        def _parcels_tag_method_overridden?(tag_name)
+          @_parcels_tag_methods_overridden ||= { }
+          @_parcels_tag_methods_overridden[tag_name.to_sym]
+        end
+
+        def _parcels_tag_method_overridden!(tag_name)
+          @_parcels_tag_methods_overridden[tag_name.to_sym] = true
+        end
+
+        def _parcels_ensure_all_tag_methods_overridden!
+          tags.each do |tag_name, tag_object|
+            done = _parcels_tag_method_overridden?(tag_name)
+            next if done
+
+            tag_object.all_method_names.each do |tag_method_name|
+              @_parcels_tag_methods_module.send(:define_method, tag_method_name) do |*args, &block|
+                content_or_attributes = args[0]
+                attributes = args[1]
+
+                directly_inside = rendering_context.current_element_nesting.last
+                if directly_inside.kind_of?(::Fortitude::Widget) && (css_wrapper_classes = directly_inside.class.try(:_parcels_widget_outer_element_classes))
+                  if attributes || content_or_attributes.kind_of?(String)
+                    super(content_or_attributes, self.class._parcels_add_wrapper_css_classes_to(attributes, css_wrapper_classes), &block)
+                  else
+                    super(self.class._parcels_add_wrapper_css_classes_to(content_or_attributes, css_wrapper_classes), attributes, &block)
+                  end
+                else
+                  super(content_or_attributes, attributes, &block)
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/parcels/fortitude/fortitude_engine.rb

@@ -0,0 +1,35 @@
+require 'tilt'
+
+module Parcels
+  module Fortitude
+    class FortitudeEngine < Tilt::Template
+      self.default_mime_type = 'text/css'
+
+      def self.engine_initialized?
+        true
+      end
+
+      def initialize_engine
+        require_template_library 'fortitude'
+      end
+
+      def prepare
+      end
+
+      def evaluate(context, locals, &block)
+        parcels_environment = context.environment.parcels
+        widget_class = parcels_environment.widget_class_from_file(context.pathname)
+
+        if widget_class
+          css_from_widget_class(widget_class, parcels_environment, context)
+        else
+          ""
+        end
+      end
+
+      def css_from_widget_class(widget_class, parcels_environment, context)
+        raise "must implement in #{self.class.name}"
+      end
+    end
+  end
+end

data/lib/parcels/fortitude/fortitude_loader.rb

@@ -0,0 +1,27 @@
+# See if we can load Fortitude -- but don't fail if we can't; we'll just use this to decide whether we should
+# load the Fortitude extensions or not.
+begin
+  gem 'fortitude'
+rescue Gem::LoadError => le
+  # ok
+end
+
+begin
+  require 'fortitude'
+rescue LoadError => le
+  # ok
+end
+
+if defined?(::Fortitude)
+  require 'parcels/fortitude/assets'
+  require 'parcels/fortitude/enabling'
+  require 'parcels/fortitude/widget_engine'
+  require 'parcels/fortitude/alongside_engine'
+
+  ::Fortitude::Widget.class_eval do
+    include ::Parcels::Fortitude::Assets
+    include ::Parcels::Fortitude::Enabling
+  end
+
+  ::Parcels.fortitude_available!
+end

data/lib/parcels/fortitude/widget_engine.rb

@@ -0,0 +1,31 @@
+require 'tilt'
+
+module Parcels
+  module Fortitude
+    class WidgetEngine < Tilt::Template
+      self.default_mime_type = 'text/css'
+
+      def self.engine_initialized?
+        true
+      end
+
+      def initialize_engine
+        require_template_library 'fortitude'
+      end
+
+      def prepare
+      end
+
+      def evaluate(context, locals, &block)
+        parcels_environment = context.environment.parcels
+        widget_class = parcels_environment.widget_class_from_file(context.pathname)
+
+        if widget_class
+          widget_class._parcels_widget_class_inline_css(parcels_environment, context)
+        else
+          ""
+        end
+      end
+    end
+  end
+end