tay 0.0.2

data/lib/tay/specification/action.rb

@@ -0,0 +1,18 @@
+module Tay
+  class Specification
+    ##
+    # Action is a parent class shared between Tay::Specification::PageAction
+    # and Tay::Specification::BrowserAction.
+    class Action
+      ##
+      # Path to the icon that is displayed in the browser
+      attr_accessor :icon
+      ##
+      # Title that appears on mouseover
+      attr_accessor :title
+      ##
+      # Path to the HTML file that is displayed when your action is clicked
+      attr_accessor :popup
+    end
+  end
+end

data/lib/tay/specification/browser_action.rb

@@ -0,0 +1,10 @@
+module Tay
+  class Specification
+    ##
+    # Represents a browser action in your extension
+    #
+    # http://code.google.com/chrome/extensions/browserAction.html
+    class BrowserAction < Action
+    end
+  end
+end

data/lib/tay/specification/content_script.rb

@@ -0,0 +1,41 @@
+module Tay
+  class Specification
+    ##
+    # Represents a content script in your extension. For more information on
+    # valid values for attributes and pattern specications, check the docs.
+    #
+    # http://code.google.com/chrome/extensions/content_scripts.html
+    class ContentScript
+      ##
+      # Specifies when to inject and run this content script.
+      attr_accessor :run_at
+
+      ##
+      # Should this content script run in every frame on a page?
+      attr_accessor :all_frames
+
+      ##
+      # An array of patterns to include this content script on
+      attr_accessor :include_patterns
+
+      ##
+      # An array of patterns to exclude this content script on
+      attr_accessor :exclude_patterns
+
+      ##
+      # An array of stylesheet paths to inject
+      attr_accessor :stylesheets
+
+      ##
+      # An array of script paths to inject
+      attr_accessor :javascripts
+
+      def initialize
+        @include_patterns = []
+        @exclude_patterns = []
+        @javascripts = []
+        @stylesheets = []
+      end
+    end
+  end
+end

data/lib/tay/specification/nacl_module.rb

@@ -0,0 +1,18 @@
+module Tay
+  class Specification
+    ##
+    # Used to map a mime-type to a native client module
+    #
+    # * http://code.google.com/chrome/extensions/manifest.html#nacl_modules
+    # * http://code.google.com/chrome/nativeclient/docs/technical_overview.html
+    class NaClModule
+      ##
+      # Path to the .nmf file for your module
+      attr_accessor :path
+
+      ##
+      # The mime-type that will load your module
+      attr_accessor :mime_type
+    end
+  end
+end

data/lib/tay/specification/packaged_app.rb

@@ -0,0 +1,33 @@
+module Tay
+  class Specification
+    ##
+    # A packaged app is included on the user's New Tab screen. They cannot have
+    # page or browser actions.
+    #
+    # http://code.google.com/chrome/extensions/apps.html
+    class PackagedApp
+      ##
+      # When your app is launched, this is the path to the HTML file that will
+      # be loaded
+      attr_accessor :page
+
+      attr_reader :container
+      attr_reader :width, :height
+
+      ##
+      # If you app should appear in its own panel, call this method, supplying
+      # the width and height of said panel
+      def appears_in_panel(width, height)
+        @container = 'panel'
+        @width = width
+        @height = height
+      end
+
+      ##
+      # If you app should appear in a standard tab (default) call this method.
+      def appears_in_tab
+        @container = 'tab'
+      end
+    end
+  end
+end

data/lib/tay/specification/page_action.rb

@@ -0,0 +1,10 @@
+module Tay
+  class Specification
+    ##
+    # Represents a page action in your extension
+    #
+    # http://code.google.com/chrome/extensions/pageAction.html
+    class PageAction < Action
+    end
+  end
+end

data/lib/tay/specification/web_intent.rb

@@ -0,0 +1,40 @@
+module Tay
+  class Specification
+    ##
+    # Represents a web intent that your extension provides. For more info
+    # check the Google Chrome extension docs, and spec at the URLs below.
+    #
+    # * http://code.google.com/chrome/extensions/manifest.html#intents
+    # * http://www.webintents.org/
+    class WebIntent
+      ##
+      # The "title" is displayed in the intent picker UI when the user
+      # initiates the action specific to the handler.
+      attr_accessor :action
+
+      ##
+      # The "title" is displayed in the intent picker UI when the user
+      # initiates the action specific to the handler.
+      attr_accessor :title
+
+      ##
+      # The "title" is displayed in the intent picker UI when the user
+      # initiates the action specific to the handler.
+      attr_accessor :href
+
+      ##
+      # Intents with "window" disposition will open a new tab when invoked,
+      # those with "inline" disposition will be displayed inside the intent
+      # picker when invoked.
+      attr_accessor :disposition
+
+      ##
+      # An array of mime types that your intent can act upon
+      attr_accessor :types
+
+      def initialize
+        @types = []
+      end
+    end
+  end
+end

data/lib/tay/specification_validator.rb

@@ -0,0 +1,167 @@
+module Tay
+  ##
+  # Takes a Tay::Specification and does sanity checks for missing required
+  # fields. It also looks for common mistakes and mutually exclusive flags.
+  #
+  # If the output directory is supplied (referencing the compiled extension),
+  # the existence of files referenced in the specification will also be checked
+  # for their presence.
+  class SpecificationValidator
+    ##
+    # Pointer to the relevant Tay::Specification
+    attr_reader :spec
+
+    ##
+    # If true (default) throw an exception on error
+    attr_accessor :violent
+
+    ##
+    # A proc object that will be called on each message with the type and msg
+    attr_accessor :on_message
+
+    attr_reader :warnings
+    attr_reader :errors
+
+    ##
+    # Convenience method to validate a specification. Creates a validator and
+    # runs it. Will throw an exception if invalid.
+    def self.validate(specification, output_directory = nil)
+      validator = SpecificationValidator.new(specification, output_directory)
+      validator.violent = true
+      validator.validate!
+    end
+
+    def initialize(specification, output_directory = nil)
+      @spec = specification
+      @out = output_directory ? Pathname.new(output_directory) : nil
+      @errors = []
+      @warnings = []
+    end
+
+    ##
+    # Facade method to call the private validation methods. Will return true if
+    # there were no warnings or errors
+    def validate!
+      validate_name
+      validate_version
+      validate_icons
+      validate_description
+
+      check_for_browser_ui_collisions
+
+      check_file_presence if @out
+
+      @warnings.empty? && @errors.empty?
+    end
+
+    protected
+
+    ##
+    # Go through the specification checking that files that are pointed to
+    # actually exist
+    def check_file_presence
+      spec.icons.values.each do |path|
+        fail_if_not_exist "Icon", path
+      end
+
+      if spec.browser_action
+        fail_if_not_exist "Browser action popup", spec.browser_action.popup
+        fail_if_not_exist "Browser action icon", spec.browser_action.icon
+      end
+
+      if spec.page_action
+        fail_if_not_exist "Page action popup", spec.page_action.popup
+        fail_if_not_exist "Page action icon", spec.page_action.icon
+      end
+
+      if spec.packaged_app
+        fail_if_not_exist "App launch page", spec.packaged_app.page
+      end
+
+      spec.content_scripts.each do |content_script|
+        content_script.javascripts.each do |script_path|
+          fail_if_not_exist "Content script javascript", script_path
+        end
+        content_script.stylesheets.each do |style_path|
+          fail_if_not_exist "Content script style", style_path
+        end
+      end
+
+      spec.background_scripts.each do |script_path|
+        fail_if_not_exist "Background script style", script_path
+      end
+
+      fail_if_not_exist "Background page", spec.background_page
+      fail_if_not_exist "Options page", spec.options_page
+
+      spec.web_intents.each do |web_intent|
+        fail_if_not_exist "Web intent href", web_intent.href
+      end
+
+      spec.nacl_modules.each do |nacl_module|
+        fail_if_not_exist "NaCl module", nacl_module.path
+      end
+
+      spec.web_accessible_resources.each do |path|
+        fail_if_not_exist "Web accessible resource", path
+      end
+    end
+
+    def validate_name
+      fatal("No name provided") unless spec.name
+      fatal("Name too long") if spec.name.length > 45
+    end
+
+    def validate_version
+      fatal("No version provided") unless spec.version
+      fatal("Invalid characters in version") if spec.version[/[^0-9\.]/]
+    end
+
+    def validate_icons
+      warn("No icons provided") if spec.icons.keys.empty?
+    end
+
+    def validate_description
+      fatal("Description too long") if spec.description && spec.description.length > 132
+    end
+
+    def check_for_browser_ui_collisions
+      count = 0
+      count += 1 if spec.packaged_app
+      count += 1 if spec.page_action
+      count += 1 if spec.browser_action
+
+      if count > 1
+        fatal('Only one of browser_action, page_action, and packaged app can be specified')
+      end
+    end
+
+    def check_for_background_collisions
+      if spec.background_page && spec.background_scripts.length > 0
+        fatal("You cannot use both background pages and background scripts")
+      end
+    end
+
+    private
+
+    def fatal(msg)
+      @errors << msg
+      unless on_message.nil?
+        on_message.call('fatal', msg)
+      end
+      raise Tay::InvalidSpecification.new if violent
+    end
+
+    def warn(msg)
+      @warnings << msg
+      unless on_message.nil?
+        on_message.call('warn', msg)
+      end
+    end
+
+    def fail_if_not_exist(what, path)
+      fatal("#{what} does not exist at '#{path}'") unless !path || @out.join(path).exist?
+    end
+  end
+
+end

data/lib/tay/utils.rb

@@ -0,0 +1,21 @@
+module Tay
+  ##
+  # Simple helpers used across various classes
+  class Utils
+    ##
+    # Convert an extension name to a filesystem friendly name
+    def self.filesystem_name(name)
+      name.gsub(/[^a-zA-Z0-9\-_ ]/, '').gsub(/ /, '_').downcase
+    end
+
+    ##
+    # Convert a path to be relative to pwd
+    def self.relative_path_to(path)
+      if path.is_a?(String)
+        path = Pathname.new(path)
+      end
+      path.relative_path_from(Pathname.new(Dir.pwd))
+    end
+
+  end
+end

data/lib/tay/version.rb

@@ -0,0 +1,3 @@
+module Tay
+  VERSION = "0.0.2"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+$:.unshift(File.expand_path('../../lib', __FILE__))
+
+require 'rspec'
+require 'tay'

data/spec/tay_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe Tay do
+  specify { Tay.should be_a(Module) }
+end

data/tay.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/tay/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Thomas Rix"]
+  gem.email         = ["tom@rixth.org"]
+  gem.summary       = %q{Tay helps you develop Chrome extensions}
+  gem.description   = gem.summary
+  gem.homepage      = "https://github.com/rixth/tay"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "tay"
+  gem.require_paths = ["lib"]
+  gem.version       = Tay::VERSION
+
+  gem.add_dependency 'thor'
+  gem.add_dependency 'tilt'
+  gem.add_dependency 'sprockets'
+  gem.add_dependency 'crxmake'
+
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'sdoc'
+  gem.add_development_dependency 'rake'
+end

metadata

@@ -0,0 +1,215 @@
+--- !ruby/object:Gem::Specification
+name: tay
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Thomas Rix
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: tilt
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sprockets
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: crxmake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Tay helps you develop Chrome extensions
+email:
+- tom@rixth.org
+executables:
+- tay
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/tay
+- lib/tay.rb
+- lib/tay/builder.rb
+- lib/tay/cli.rb
+- lib/tay/cli/build.rb
+- lib/tay/cli/generate.rb
+- lib/tay/cli/generators/browser_action.rb
+- lib/tay/cli/generators/content_script.rb
+- lib/tay/cli/generators/page_action.rb
+- lib/tay/cli/generators/templates/browser_action/action.css
+- lib/tay/cli/generators/templates/browser_action/action.html
+- lib/tay/cli/generators/templates/browser_action/action.js
+- lib/tay/cli/generators/templates/browser_action/tayfile
+- lib/tay/cli/generators/templates/content_script/content_script.css
+- lib/tay/cli/generators/templates/content_script/content_script.js
+- lib/tay/cli/generators/templates/content_script/tayfile
+- lib/tay/cli/generators/templates/page_action/controller.js
+- lib/tay/cli/generators/templates/page_action/icon.png
+- lib/tay/cli/generators/templates/page_action/tayfile
+- lib/tay/cli/helpers.rb
+- lib/tay/cli/minify.rb
+- lib/tay/cli/new.rb
+- lib/tay/cli/package.rb
+- lib/tay/cli/templates/Gemfile
+- lib/tay/cli/templates/Tayfile
+- lib/tay/cli/templates/gitignore
+- lib/tay/cli/validate.rb
+- lib/tay/cli/watch.rb
+- lib/tay/manifest_generator.rb
+- lib/tay/packager.rb
+- lib/tay/specification.rb
+- lib/tay/specification/action.rb
+- lib/tay/specification/browser_action.rb
+- lib/tay/specification/content_script.rb
+- lib/tay/specification/nacl_module.rb
+- lib/tay/specification/packaged_app.rb
+- lib/tay/specification/page_action.rb
+- lib/tay/specification/web_intent.rb
+- lib/tay/specification_validator.rb
+- lib/tay/utils.rb
+- lib/tay/version.rb
+- spec/spec_helper.rb
+- spec/tay_spec.rb
+- tay.gemspec
+homepage: https://github.com/rixth/tay
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -81594321510644905
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -81594321510644905
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Tay helps you develop Chrome extensions
+test_files:
+- spec/spec_helper.rb
+- spec/tay_spec.rb