RubyGems - autorefresh - Versions diffs - 1.0.0 - Mend

autorefresh 1.0.0

Files changed (13) hide show

data/.document ADDED

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+-
+features/**/*.feature
+LICENSE.txt

data/Gemfile ADDED

@@ -0,0 +1,16 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+gem "pusher", ">= 0.7.0"
+gem "watchr", ">= 0.7"
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "bacon", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock ADDED

@@ -0,0 +1,33 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    bacon (1.1.0)
+    crack (0.1.8)
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    json (1.4.6)
+    pusher (0.7.0)
+      crack (~> 0.1.0)
+      json (~> 1.4.0)
+      ruby-hmac (~> 0.4.0)
+      signature (~> 0.1.2)
+    rake (0.8.7)
+    rcov (0.9.9)
+    ruby-hmac (0.4.0)
+    signature (0.1.2)
+      ruby-hmac
+    watchr (0.7)
+PLATFORMS
+  ruby
+DEPENDENCIES
+  bacon
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  pusher (>= 0.7.0)
+  rcov
+  watchr (>= 0.7)

data/LICENSE.txt ADDED

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Logan Koester
+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.rdoc ADDED

@@ -0,0 +1,78 @@
+= AutoRefresh
+AutoRefresh is inspired by XRefresh[http://xrefresh.binaryage.com/], a tool to
+automatically refresh your browser when a file has changed, allowing web
+designers working with multiple monitors to preview changes without leaving
+your editor.
+XRefresh requires that you install a Firefox extension and run a local server
+to watch for changes in your files, and only works on Mac/Windows.
+AutoRefresh approaches the problem in a different way, using watchr[https://github.com/mynyml/watchr].
+== Installation
+  gem install autorefresh
+== Usage
+Add the AutoRefresh gem to your project
+  require 'autorefresh'
+Insert a JavaScript snippet in your page template using the AutoRefresh helper.
+Remember only to include this snippet in your development environment, so users
+don't end up getting their page refreshed. You should give your channel a unique
+name that won't conflict with other developers using AutoRefresh.
+  <html>
+    <head>
+      <%= AutoRefresh.channel('myproject') %>
+    </head>
+  </html>
+Now create a refresh.watchr file (or use an existing file, if you are already
+using Watchr to run your tests), and add some rules for the files you want
+to watch using regular expressions.
+refresh.watchr
+  watch( 'public/stylesheets/.*\.css' ) { |m| system('autorefresh myproject') }
+Now run Watchr to begin observing changes in your files.
+  $ watchr refresh.watchr
+And enjoy your new workflow!
+=== Usage without ERB
+Simply use this snippet instead of the automatic helper.
+  <script src="http://js.pusherapp.com/1.6/pusher.js" type="text/javascript"></script>
+  <script type="text/javascript">
+    var pusher = new Pusher('a2024b659f492cab86cc');
+    pusher.subscribe('yourproject');
+    pusher.bind('refresh', function(data) {
+      location.reload(true);
+    });
+  </script>
+=== Usage without Watchr
+The *autorefresh* system command sends a refresh signal to your channel.
+  $ autorefresh myproject
+You could bind this to a key in your editor, or whatever other method you prefer.
+== Contributing to AutoRefresh
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+== Copyright
+Copyright (c) 2011 Logan Koester. See LICENSE.txt for
+further details.

data/Rakefile ADDED

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "autorefresh"
+  gem.homepage = "http://github.com/logankoester/autorefresh"
+  gem.license = "MIT"
+  gem.summary = %Q{Automatically refresh your browser when a file has changed (using WebSockets)}
+  gem.description = %Q{Automatically refresh your browser when a file has changed}
+  gem.email = "logan@logankoester.com"
+  gem.authors = ["Logan Koester"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+require 'rake/testtask'
+Rake::TestTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.verbose = true
+end
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |spec|
+  spec.libs << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.verbose = true
+end
+task :default => :spec
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "autorefresh #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION ADDED

	@@ -0,0 +1 @@
1	+ 1.0.0

data/bin/autorefresh ADDED

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+require File.join( File.expand_path(File.dirname(__FILE__)), '..', 'lib', 'autorefresh')
+USAGE = %q{
+autorefresh - Send listening browsers a signal to refresh the page.
+Usage: autorefresh <channel>
+For more information, see https://github.com/logankoester/autorefresh
+}.lstrip
+if ARGV[0]
+  AutoRefresh.refresh(ARGV[0])
+else
+  puts USAGE
+end

data/lib/autorefresh.rb ADDED

@@ -0,0 +1,28 @@
+require 'pusher'
+# Automatically refresh your browser using WebSockets
+class AutoRefresh
+  @@pusher_key = 'a2024b659f492cab86cc'
+  @@pusher_app_id = '3735'
+  @@pusher_secret = '3ce64d76b4288e4ba449'
+  def self.channel(chan)
+    %q{
+      <script src="http://js.pusherapp.com/1.6/pusher.js" type="text/javascript"></script>
+      <script type="text/javascript">
+        var pusher = new Pusher('PUSHER_KEY');
+        pusher.subscribe('CHANNEL');
+        pusher.bind('refresh', function(data) {
+          location.reload(true);
+        });
+      </script>
+    }.gsub(/CHANNEL/, chan).gsub(/PUSHER_KEY/, @@pusher_key)
+  end
+  def self.refresh(chan)
+    Pusher.app_id = @@pusher_app_id
+    Pusher.key = @@pusher_key
+    Pusher.secret = @@pusher_secret
+    Pusher[chan].trigger('refresh', {})
+  end
+end

data/spec/autorefresh_spec.rb ADDED

@@ -0,0 +1,33 @@
+require File.join( File.expand_path(File.dirname(__FILE__)), 'spec_helper')
+describe "The AutoRefresh helper" do
+  before do
+    @channel = 'testchannel'
+    @helper = AutoRefresh.channel(@channel)
+  end
+  it "should accept a channel name and return a string" do
+    @helper.class.should.equal String
+  end
+  it "should include the pusher js client" do
+    @helper.should.match /src=".*pusher\.js/
+  end
+  it "should set the Pusher key" do
+    @helper.should.match /new Pusher\('#{AutoRefresh.pusher_key}'\)/
+  end
+  it "should subscribe to the specified channel" do
+    @helper.should.match /pusher\.subscribe\('#{@channel}'\)/
+  end
+end
+describe "Sending a refresh event" do
+  before do
+  end
+  it "should return true" do
+    @result = AutoRefresh.refresh(@channel)
+    @result.should.equal true
+  end
+end

data/spec/spec.watchr ADDED

	@@ -0,0 +1,2 @@
1	+ watch( 'lib/(.*)\.rb' ) {\|md\| system("bacon spec/autorefresh_spec.rb") }
2	+ watch( 'spec/(.*)\.rb' ) {\|md\| system("bacon spec/autorefresh_spec.rb") }

data/spec/spec_helper.rb ADDED

@@ -0,0 +1,22 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'bacon'
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'autorefresh'
+Bacon.summary_on_exit
+class AutoRefresh
+  def self.pusher_key
+    @@pusher_key
+  end
+end

metadata ADDED

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: autorefresh
+version: !ruby/object:Gem::Version
+  prerelease: false
+  segments:
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors:
+- Logan Koester
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2011-01-18 00:00:00 -05:00
+default_executable: autorefresh
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pusher
+  requirement: &id001 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        segments:
+        - 0
+        - 7
+        - 0
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency
+  name: watchr
+  requirement: &id002 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        segments:
+        - 0
+        - 7
+        version: "0.7"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency
+  name: bacon
+  requirement: &id003 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        segments:
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &id004 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        segments:
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &id005 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        segments:
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &id006 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        segments:
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id006
+description: Automatically refresh your browser when a file has changed
+email: logan@logankoester.com
+executables:
+- autorefresh
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/autorefresh
+- lib/autorefresh.rb
+- spec/autorefresh_spec.rb
+- spec/spec.watchr
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/logankoester/autorefresh
+licenses:
+- MIT
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      hash: 2802726110151825551
+      segments:
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      version: "0"
+requirements: []
+rubyforge_project:
+rubygems_version: 1.3.7
+signing_key:
+specification_version: 3
+summary: Automatically refresh your browser when a file has changed (using WebSockets)
+test_files:
+- spec/autorefresh_spec.rb
+- spec/spec_helper.rb