opal 0.0.1 → 0.1.0

data/lib/opal/models/build_item.rb

@@ -0,0 +1,104 @@
+# 
+# build_item.rb
+# vienna
+# 
+# Created by Adam Beynon.
+# Copyright 2010 Adam Beynon.
+#
+# 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.
+#
+
+require File.join(File.dirname(__FILE__), 'struct_accessors')
+
+module Vienna
+  
+  # An item to be build (ruby, css, image etc)
+  class BuildItem
+    
+    include StructAccessors
+    
+    # target
+    attr_reader :target
+    
+    def initialize(target, options={})
+      # puts "making a new build item with filename: #{options[:filename]}"
+      @target = target
+      merge! options
+    end
+    
+    # Should this item be included in the build. Items might be to start, but
+    # might then be hidden. e.g, ruby files are first put in a copy stage, but
+    # then they are changed to a 'build:ruby' stage instead, so the inital item
+    # will become hidden.
+    def hidden?
+      self[:hidden] ||= false
+    end
+    
+    # For use with above: actually sets builditem to be hidden
+    def hide!
+      self[:hidden] = true
+      self
+    end
+    
+    # This is called whenever the build item is created. Uses 'entry:prepare' 
+    # task
+    def prepare!
+      opalfile = target.opalfile
+      if opalfile.has_task? 'build_item:prepare'
+        opalfile.invoke 'build_item:prepare',
+          :build_item => self,
+          :target     => target,
+          :config     => target.config,
+          :project    => target.project
+      end
+      self
+    end
+    
+    # Build the item
+    def build!
+      build_to build_path
+    end
+    
+    def stage!
+      build_to staging_path
+    end
+    
+    def build_to(dst_path)
+      raise "no build task defined for #{filename}" if build_task.nil?
+      
+      # find build task
+      opalfile = target.opalfile
+      if !opalfile.has_task? build_task
+        raise "Could not build #{filename}: no task defined (#{build_task})"
+      end
+      
+      opalfile.invoke build_task,
+        :build_item => self,
+        :target     => target,
+        :config     => target.config,
+        :project    => target.project,
+        :src_path   => source_path,
+        :src_paths  => source_paths,
+        :dst_path   => dst_path
+      
+      self
+    end
+    
+  end
+end

data/lib/opal/models/hash_struct.rb

@@ -0,0 +1,40 @@
+# 
+# hash_struct.rb
+# vienna
+# 
+# Created by Adam Beynon.
+# Copyright 2010 Adam Beynon.
+#
+# 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.
+#
+
+require File.join(File.dirname(__FILE__), 'struct_accessors')
+
+module Vienna
+  
+  class HashStruct
+    
+    include StructAccessors
+    
+    def initialize(hash)
+      merge! hash
+    end
+    
+  end
+end

data/lib/opal/models/project.rb

@@ -0,0 +1,215 @@
+# 
+# project.rb
+# vienna
+# 
+# Created by Adam Beynon.
+# Copyright 2010 Adam Beynon.
+#
+# 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.
+#
+
+module Vienna
+  
+  class Project
+    
+    # full path to project
+    attr_reader :project_root
+    
+    # build options
+    attr_reader :build_options
+    
+    # the main target
+    attr_reader :main_target
+    
+    def self.load project_path
+      if File.exists? File.join(project_path, 'Opalfile')
+        return new(project_path)
+      end
+      nil
+    end
+    
+    BASE_OPALFILE = File.join(Vienna::PATH, 'Opalfile')
+    
+    def initialize(project_root, build_options={})
+      
+      # unless File.exists? File.join(project_root, 'Opalfile')
+      #   raise "Not a valid project (no Opalfile)"
+      # end
+      
+      @opalfile = nil
+      @config = nil
+      
+      @build_options = build_options
+      @project_root = project_root
+      @targets = nil
+      # lets begin by loading our root opalfile
+      # @opalfile = Opalfile.new(BASE_OPALFILE)
+      opalfile
+      # puts "\n\n\n\n######################################## ENV"
+      # p Opalfile.env
+      # puts "######################################## TASKS"
+      # puts @opalfile.tasks.each_key.map { |key| key }
+      # puts "######################################## DONE\n\n\n\n"
+    end
+    
+    def project_name
+      @project_name ||= File.basename @project_root
+    end
+    
+    def inspect
+      "#<Vienna::Project #{File.basename(project_root)}>"
+    end
+    
+    # Opalfile is a build task setup for each bundle, app, opal or theme. It 
+    # allows the developer to setup custom build options and processes which
+    # can depend on the environment etc. Inspired by Buildfiles in Sproutcore.
+    def opalfile
+      return @opalfile if @opalfile
+      Opalfile.root_opalfile = BASE_OPALFILE
+      @opalfile = Opalfile.root_opalfile
+    end
+    
+    def config
+      @config
+      # ...
+    end
+    
+    # Add some options to main config
+    def options(options={})
+      # options.each do |key, value|
+        opalfile.config project_name.to_sym, options
+      # end
+    end
+    
+    # Add a new referenced target (target_name) from the given target. The given
+    # target is used as it might have a sub-vendor or sub-theme where the given
+    # target is actually stored.
+    def require_target(target_name, from_target)
+      
+    end
+    
+    # Every target. A target is a opal, theme, or application. Recursively find
+    # if needed.
+    def targets
+      # If we have already found them, just return them
+      return @targets if @targets
+      # hash of targets: target name to target instance
+      @targets = {}
+      # first we must add ourselves as a target - default is opal type 
+      # application
+      # puts "need to add self as target"
+      target = add_target :target_name => File.basename(project_root),
+                 :target_type => :opal,
+                 :target_root => project_root,
+                 :project     => self,
+                 :main_target => true
+                 
+      @main_target = target
+      # find all targets for this project_root with given config
+      find_targets_for target, config
+      
+      # puts "finished finding targets"
+      # targets
+      @targets
+    end
+    
+    # Find all targets relative to the given root_path with the given config
+    def find_targets_for the_target, config
+      # puts "looking for targets..... #{the_target.target_name} .. #{@targets.inspect}"
+      # p the_target.opalfile
+      # puts "looking for targets"
+      # puts the_target.required.inspect
+      # puts "down to here"
+      the_target.required.each do |target|
+        # if we already know about the target, skip it
+        next if @targets.has_key?(target.to_s)
+        # currently only look in our own opals/ root
+        try_path = File.join(Vienna::PATH, 'opals', target.to_s)
+        
+        if File.exist?(try_path) and File.directory?(try_path)
+          # found target, so add it
+          target = add_target :target_name  => target.to_s,
+                              :target_type  => :opal,
+                              :target_root  => try_path,
+                              :project      => self
+          # search this target for all dependencies
+          find_targets_for target, config
+        else
+          raise "Could not find required opal #{target}. (Required in #{the_target.target_name})"
+        end
+      end
+      
+      # puts "and all the way to here"
+      
+    end
+    
+    # add a target
+    def add_target(options)
+      targets[options[:target_name]] = Target.new options
+    end
+    
+    def clean!
+      main_target.opalfile.invoke 'build:clean',
+        :project  => self,
+        :target   => main_target,
+        :config   => main_target.config
+    end
+    
+    def build!()
+      # get main target and put it at the end
+      all_targets = targets.each_value.to_a
+      
+      # puts "all of our targets:"
+      
+      # puts all_targets
+
+      all_targets.push all_targets.slice!(all_targets.index @main_target)
+      all_targets.each do |target|
+        
+        # puts "\n############################################################"
+        # puts "# #{target.target_name}"
+        # puts "############################################################\n"
+        # prepare
+        target.prepare!
+        # go through and build each to get list of build_items
+        target.build!
+      end
+      
+      # only once we have built all our targets do we run the pacakge command
+      # because some reliances will mean opal etc are not available until every
+      # opal is built
+      # puts "main target.."
+      main_target.opalfile.invoke 'build:package', 
+        :project  => self,
+        :target   => main_target,
+        :config   => main_target.config
+    end
+    
+    # def get the build mode
+    def build_mode
+      @build_options[:build_mode] || :debug
+    end
+    
+    # build root. by default this is the root of the main target, but can be 
+    # custom
+    def build_root
+      @build_options[:build_root] || @main_target.target_root
+    end
+  end
+end

data/lib/opal/models/struct_accessors.rb

@@ -0,0 +1,58 @@
+# 
+# struct_accessors.rb
+# vienna
+# 
+# Created by Adam Beynon.
+# Copyright 2010 Adam Beynon.
+#
+# 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.
+#
+
+module Vienna
+
+  module StructAccessors
+    
+    def method_missing(accessor_name, *args)
+      accessor_name = accessor_name.to_s
+      
+      # accessor =
+      if accessor_name =~ /=$/
+        accessor_name = accessor_name[0..-2]
+        self[accessor_name] = args[0]      
+      else # acessor
+        self[accessor_name]
+      end
+    end
+    
+    def merge!(options)
+      @__struct_accessors__ ||= {}
+      @__struct_accessors__.merge! options
+      self
+    end
+    
+    def [](key)
+      @__struct_accessors__[key.to_sym]
+    end
+    
+    def []=(key, value)
+      @__struct_accessors__[key.to_sym] = value
+    end
+    
+  end
+end

data/lib/opal/models/target.rb

@@ -0,0 +1,176 @@
+# 
+# target.rb
+# vienna
+# 
+# Created by Adam Beynon.
+# Copyright 2010 Adam Beynon.
+#
+# 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.
+#
+
+require File.join(File.dirname(__FILE__), 'struct_accessors')
+
+module Vienna
+  
+  class Target
+    
+    include StructAccessors
+    
+    attr_reader :target_name, :target_type, :target_root, :project
+    
+    def initialize(opts={})
+      @target_name = opts.delete :target_name
+      @target_root = opts.delete :target_root
+      @target_type = opts.delete :target_type
+      @project = opts.delete :project
+      @build_items = []
+      @main_target = opts.delete(:main_target) || false
+      @required = nil
+      merge! opts
+      
+      # get opalfile all setup
+      opalfile
+      # puts "\n\n\n\n######################################## ENV"
+      # p Opalfile.env
+      # puts "######################################## TASKS"
+      # puts @opalfile.tasks.each_key.map { |key| key }
+      # puts "######################################## DONE\n\n\n\n"
+    end
+    
+    # builditems.. on;y those that are not hidden
+    def build_items
+      @build_items.reject { |e| e.hidden? }
+    end
+    
+    # is this the main target
+    def main_target?
+      @main_target
+    end
+    
+    def inspect
+      "#<Target name=#{target_name}, type=#{target_type}>"
+    end
+    
+    def opalfile
+      @opalfile ||= Opalfile.new File.join(target_root, 'Opalfile')
+    end
+    
+    # An array of the required items from the opal file
+    def required
+      return @required if @required
+      # puts "checking required"
+      req = config[:required]
+      # puts "did check rrquired"
+      # also make sure we include opal: bad things will happen if we dont
+      @required = case req
+      when Array
+        unless req.include? :opal
+          req << :opal
+        end
+        
+        req
+      when Symbol
+        if req == :opal
+          [req]
+        else
+          [req, :opal]
+        end
+      else
+        # browser if we do not specify anything..
+        [:opal, :browser]
+      end
+    end
+    
+    def config
+      @config ||= HashStruct.new(Opalfile.config_for(project.build_mode, target_name.to_sym))
+    end
+    
+    def prepare!
+      # return
+      # return @self if @is_prepared
+      # puts "===== preparing #{target_name}"
+      # @is_prepared = true
+      # reset build items
+      @build_items = []
+      if opalfile.has_task? 'target:prepare'
+        opalfile.invoke 'target:prepare', :target   => self, 
+                                          :project  => project,
+                                          :config   => config
+      end
+      self
+    end
+    
+    def build!
+      # return
+      if opalfile.has_task? 'target:build'
+        opalfile.invoke 'target:build', :target   => self,
+                                        :project  => project,
+                                        :config   => config
+      end
+      
+      # puts "################################################ build_items"
+      
+      # at this point we will have a list of all our actual build items.. so go
+      # build them
+      build_items.each do |item|
+        # p item
+        item.build!
+      end
+      self
+    end
+    
+    # find the build item with the given filename
+    def build_item_for(filename)
+      @build_items.find do |item|
+        item.filename == filename
+      end
+    end
+    
+    # Add an item to be built. The path is relative to the target root.
+    def add_build_item(item_path, options={})
+      options[:filename] = item_path
+      @build_items << (res = BuildItem.new(self, options)).prepare!
+      res
+    end
+    
+    # add transform (i.e. not just a copy file stage, but we need to compile it
+    # etc)
+    def add_transform(build_item, options={})
+      # puts "adding transform"
+      @build_items << (res = BuildItem.new(self, options)).prepare!
+      build_item.hide!
+    end
+    
+    def add_composite(filename, options={})
+      options[:filename] = filename
+      options[:source_items] ||= []
+      options[:composite] = true
+      
+      options[:build_path] ||= File.join(build_root, filename)
+      options[:staging_path] ||= File.join(staging_root, filename)
+      
+      options[:target] ||= self
+      options[:project] ||= self
+      
+      @build_items << (res = BuildItem.new(self, options)).prepare!
+      res.source_items.each { |item| item.hide! }
+      res
+    end
+  end
+end