visionmedia-css 0.0.2

data/History.rdoc

@@ -0,0 +1,8 @@
+
+=== 0.0.2 / 2008-12-12
+
+* Forgot the commander gem dependency :)
+
+=== 0.0.1 / 2008-12-12
+
+* Initial release

data/Manifest

@@ -0,0 +1,17 @@
+bin/css
+History.rdoc
+lib/css/version.rb
+lib/css/watcher.rb
+lib/css.rb
+Manifest
+Rakefile
+README.rdoc
+spec/css_spec.rb
+spec/fixtures/style.css
+spec/spec_helper.rb
+tasks/docs.rake
+tasks/gemspec.rake
+tasks/spec.rake
+test/index.html
+test/style.css
+Todo.rdoc

data/README.rdoc

@@ -0,0 +1,50 @@
+
+= CSS
+
+Stylesheet task automation such as realtime editing.
+
+== Examples:
+
+Currently the only feature provided by the css rubygem is to monitor
+changes made to a file, refresh browser(s) specified, while keeping
+your text editor in focus. To do this simply invoke the 'css' command
+like so:
+
+  $ css watch path/to/style.css
+
+  $ css watch path/to/style.css --browsers safari,firefox,opera --interval 10
+
+Keep in mind if you are going to watch several browsers at one time,
+you better have extra monitors :). The only requirement in your stylesheet file is to 
+have a watch url such as below which can be placed anywhere in the document:
+
+  /* watch: file:///Users/tjholowaychuk/Scripts/gems/css/test/index.html */
+
+== Known Issues:
+
+* Mac OS only, sorry windowz ;)
+
+== License:
+
+(The MIT License)
+
+Copyright (c) 2008 TJ Holowaychuk
+
+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, an d/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/Rakefile

@@ -0,0 +1,12 @@
+
+%w( rubygems rake echoe ./lib/css.rb ).each { |lib| require lib }
+
+Echoe.new("css", CSS::VERSION::STRING) do |p|
+  p.author = "TJ Holowaychuk"
+  p.email = "tj@vision-media.ca"
+  p.summary = "Stylesheet task automation such as realtime editing"
+  p.url = "http://github.com/visionmedia/css"
+  p.runtime_dependencies = ["visionmedia-commander >=2.1.1"]
+end
+
+Dir['tasks/**/*.rake'].sort.each { |lib| load lib }

data/Todo.rdoc

@@ -0,0 +1,12 @@
+
+== Major:
+
+* Nothing
+
+== Minor:
+
+* Nothing
+
+== Brainstorming:
+
+* Nothing

data/bin/css

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'commander'
+require 'css'
+
+program :name, 'css'
+program :version, CSS::VERSION::STRING
+program :description, 'Stylesheet task automation such as realtime editing.'
+ 
+command :watch do |c|
+  c.syntax = 'css watch <file>'
+  c.summary = 'Watch a stylesheet for changes, auto-refreshing browsers'
+  c.description = 'Watch a stylesheet for changes, auto-refreshing browsers specified by the --browsers option'
+  c.example 'Watch a stylesheet with Safari and Firefox', 'css watch style.css --browsers safari,firefox'
+  c.option '--browsers BROWSERS', Array, 'Specify the browsers to watch, defaults to Safari'
+  c.option '--interval SECONDS', Integer, 'Interval in seconds for checking the modification time of the stylesheet watched. Defaults to 2'
+  c.option '--debug', 'Run in debug mode'
+  c.when_called do |args, options|
+    include CSS::Watcher
+    raise 'Stylesheet required' if args.empty?
+    raise '%s is not a valid stylesheet' % args.first unless File.file?(args.first)
+    stylesheet = args.first
+    interval = options.interval || 2
+    browsers = options.browsers || ['safari']
+    say '... Watching %s for modifications every %s seconds' % [stylesheet, interval]
+    say '... Press CTRL + C to terminate process'
+    url = get_url_from_stylesheet stylesheet
+    log 'url', url if options.debug
+    loop do
+      if stylesheet_has_changed? stylesheet
+        log 'refresh', browsers.join(', ') if options.debug
+        refresh_browsers_to_url browsers, url
+      end
+      sleep interval
+    end
+  end
+end
+

data/css.gemspec

@@ -0,0 +1,39 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{css}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["TJ Holowaychuk"]
+  s.date = %q{2008-12-12}
+  s.default_executable = %q{css}
+  s.description = %q{Stylesheet task automation such as realtime editing}
+  s.email = %q{tj@vision-media.ca}
+  s.executables = ["css"]
+  s.extra_rdoc_files = ["bin/css", "lib/css/version.rb", "lib/css/watcher.rb", "lib/css.rb", "README.rdoc", "tasks/docs.rake", "tasks/gemspec.rake", "tasks/spec.rake"]
+  s.files = ["bin/css", "History.rdoc", "lib/css/version.rb", "lib/css/watcher.rb", "lib/css.rb", "Manifest", "Rakefile", "README.rdoc", "spec/css_spec.rb", "spec/fixtures/style.css", "spec/spec_helper.rb", "tasks/docs.rake", "tasks/gemspec.rake", "tasks/spec.rake", "test/index.html", "test/style.css", "Todo.rdoc", "css.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/visionmedia/css}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Css", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{css}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Stylesheet task automation such as realtime editing}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<visionmedia-commander>, [">= 2.1.1"])
+      s.add_development_dependency(%q<echoe>, [">= 0"])
+    else
+      s.add_dependency(%q<visionmedia-commander>, [">= 2.1.1"])
+      s.add_dependency(%q<echoe>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<visionmedia-commander>, [">= 2.1.1"])
+    s.add_dependency(%q<echoe>, [">= 0"])
+  end
+end

data/lib/css.rb

@@ -0,0 +1,27 @@
+#--
+# Copyright (c) 2008 TJ Holowaychuk
+#
+# 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.
+#++
+
+$:.unshift File.dirname(__FILE__)
+
+require 'css/version'
+require 'css/watcher'

data/lib/css/version.rb

@@ -0,0 +1,7 @@
+
+module CSS
+  module VERSION #:nodoc:
+    MAJOR, MINOR, TINY = [0, 0, 2]
+    STRING = [MAJOR, MINOR, TINY].join '.'
+  end
+end

data/lib/css/watcher.rb

@@ -0,0 +1,53 @@
+
+module CSS
+  
+  ##
+  # = Watcher
+  #
+  # The stylesheet watcher is in charge of monitoring
+  # modifications made to a specific stylesheet, then refreshing
+  # browsers appropriately while keeping your text editor in focus.
+  
+  module Watcher
+    
+    class Error < StandardError; end
+    class NoWatchURLError < StandardError; end
+    
+    ##
+    # When the stylesheet was last checked for modifications.
+    
+    @@last_checked = 0
+    
+    module_function
+    
+    ##
+    # Parse url from _file_. This should be in the format 
+    # of /* watch: http://example.com/path/ */ which is then
+    # used as the page to refresh to.
+    
+    def get_url_from_stylesheet file
+      url = $1.strip if File.read(file).match /watch: +((https?|file):\/\/.*?)\*\//i
+      raise NoWatchURLError, "No '/* watch: url */' found in #{file}" if url.nil?
+      url
+    end
+    
+    ##
+    # Refresh all _browsers_ to the specified _url_.
+    
+    def refresh_browsers_to_url browsers, url
+      browsers.each do |browser|
+        system 'open -a %s %s --background' % [browser, url]
+      end
+    end
+    
+    ##
+    # Check if a stylesheet has been modified within the
+    # last interval checked.
+    
+    def stylesheet_has_changed? file
+      status = File.new(file).mtime.to_i > @@last_checked
+      @@last_checked = Time.now.to_i
+      status
+    end
+  end
+end

data/spec/css_spec.rb

@@ -0,0 +1,11 @@
+
+describe "Watcher" do
+  it "should parse watch: url from a file" do
+    url = CSS::Watcher.get_url_from_stylesheet File.dirname(__FILE__) + '/fixtures/style.css'
+    url.should eql('http://example.com/whatever/something.ext')
+  end
+  
+  it "should raise an error when no watch url is found" do
+    lambda { CSS::Watcher.get_url_from_stylesheet __FILE__ }.should raise_error(CSS::Watcher::NoWatchURLError)
+  end
+end

data/spec/fixtures/style.css

@@ -0,0 +1,6 @@
+
+/* watch: http://example.com/whatever/something.ext */
+
+body {
+  /* lame */
+}

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+
+require 'css'

data/tasks/docs.rake

@@ -0,0 +1,13 @@
+
+namespace :docs do
+    
+  desc 'Remove rdoc products'
+  task :remove => [:clobber_docs]
+  
+  desc 'Build docs, and open in browser for viewing (specify BROWSER)'
+  task :open => [:docs] do
+    browser = ENV["BROWSER"] || "safari"
+    sh "open -a #{browser} doc/index.html"
+  end
+  
+end

data/tasks/gemspec.rake

@@ -0,0 +1,3 @@
+
+desc 'Build gemspec file'
+task :gemspec => [:build_gemspec]

data/tasks/spec.rake

@@ -0,0 +1,25 @@
+
+require 'spec/rake/spectask'
+
+desc "Run all specifications"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.libs << "lib"
+  t.spec_opts = ["--color", "--require", "spec/spec_helper.rb"]
+end
+
+namespace :spec do
+  
+  desc "Run all specifications verbosely"
+  Spec::Rake::SpecTask.new(:verbose) do |t|
+    t.libs << "lib"
+    t.spec_opts = ["--color", "--format", "specdoc", "--require", "spec/spec_helper.rb"]
+  end
+  
+  desc "Run specific specification verbosely (specify SPEC)"
+  Spec::Rake::SpecTask.new(:select) do |t|
+    t.libs << "lib"
+    t.spec_files = [ENV["SPEC"]]
+    t.spec_opts = ["--color", "--format", "specdoc", "--require", "spec/spec_helper.rb"]
+  end
+  
+end

data/test/index.html

@@ -0,0 +1,18 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+		"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+	<head>
+		<title>CSS Watcher Test</title>
+		<link rel="stylesheet" href="style.css" type="text/css" media="screen" charset="utf-8" />
+	</head>
+	<body>
+		<div id="content">
+			<h1>Heading</h1>
+			<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in repreest laborum.</p>
+			<h2>Heading 2</h2>
+			<p class="double">Sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute ir</p>
+			<p class="double">Sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute ir</p>
+			<div class="clear"></div>
+		</div>
+	</body>
+</html>

data/test/style.css

@@ -0,0 +1,50 @@
+
+/* watch: file:///Users/tjholowaychuk/Scripts/gems/css/test/index.html */
+
+body {
+  margin: 30px;
+  font: 12px "Arial";
+  color: #888;
+}
+h1, h2, h3 {
+  margin-top: 35px;
+  font: 30px "Lucida Grande";
+  font-weight: normal;
+  color: #000;
+  text-shadow: 1px 1px 2px #C4C4C4; 
+  -webkit-transition-properties: color;
+  -webkit-transition-duration: 0.3s;
+  -webkit-transition-timing-function: ease-in-out;
+}
+h1:hover, h2:hover, h3:hover {
+  color: red;
+}
+h2 {
+  font-size: 20px;
+}
+p {
+  line-height: 1.5;
+  width: 40%;
+  -webkit-transition-properties: color, padding, -webkit-transform;
+  -webkit-transition-duration: 0.3s;
+  -webkit-transition-timing-function: ease-in-out;
+}
+p:hover {
+  padding: 10px 25px;
+  color: #000;
+  -webkit-transform: rotate(360deg) scale(1.2);
+}
+p.double {
+  float: left;
+  padding-right: 20px;
+  width: 19%;
+  font-size: 11px;
+}
+.clear {
+  display: block;
+  clear: both;
+}
+#content {
+  padding: 0 25px 20px 25px;
+  border: 1px solid #eee;
+}

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification 
+name: visionmedia-css
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- TJ Holowaychuk
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-12-12 00:00:00 -08:00
+default_executable: css
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: visionmedia-commander
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.1.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: echoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Stylesheet task automation such as realtime editing
+email: tj@vision-media.ca
+executables: 
+- css
+extensions: []
+
+extra_rdoc_files: 
+- bin/css
+- lib/css/version.rb
+- lib/css/watcher.rb
+- lib/css.rb
+- README.rdoc
+- tasks/docs.rake
+- tasks/gemspec.rake
+- tasks/spec.rake
+files: 
+- bin/css
+- History.rdoc
+- lib/css/version.rb
+- lib/css/watcher.rb
+- lib/css.rb
+- Manifest
+- Rakefile
+- README.rdoc
+- spec/css_spec.rb
+- spec/fixtures/style.css
+- spec/spec_helper.rb
+- tasks/docs.rake
+- tasks/gemspec.rake
+- tasks/spec.rake
+- test/index.html
+- test/style.css
+- Todo.rdoc
+- css.gemspec
+has_rdoc: true
+homepage: http://github.com/visionmedia/css
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Css
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: css
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Stylesheet task automation such as realtime editing
+test_files: []
+