browser_sync_rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f106531b2f15b635ddf89b2db3fff3ffb992a7c2
+  data.tar.gz: f03547899185f5791cc357dc392a4e6ee1f81700
+SHA512:
+  metadata.gz: 5448c7e5bcfd2fb35daf0a26d568418583b47132266e4c9301450ff001d522a36402a24337093e06d292a22aca357168517dadc8aca0caf33d4601aee23c23cb
+  data.tar.gz: 5e3aad8e0283f0fbb4e4426b6a379c0db96723a42ad0fe5e579999efc8217d9dce590398715379a3840127b62fbf95ec7c007c98f6774632c7134d5105f124e0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Bruno Konrad
+
+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,69 @@
+# Browser Sync Rails
+
+This gem is a *easier* way to use [browser sync](https://browsersync.io) with your rails app.
+
+## Getting started
+
+You can add it to your Gemfile with:
+
+```ruby
+group :development do
+  gem 'browser_sync_rails'
+end
+```
+
+Then run the bundle command to install it.
+
+After you install the gem, you need to run the generator:
+
+```sh
+bundle exec rails generate browser_sync_rails:install
+```
+
+This generator will prepare your environment for browser sync.
+
+## Using
+
+You will use the browser sync along with your rails app. So you need to start the rails app normally and, in another terminal instance, start the browser sync.
+
+The browser sync will proxy your running app and will handle the live reloading and synchronization between multiple devices.
+
+Run this rake task to start it:
+
+```sh
+bundle exec rake browser_sync:start
+```
+
+## Configurations
+
+By default this gem watch for `app/assets` and `app/views`. You can also add more files to watch or change the host or port.
+
+It is done in `config/browser_sync.yml`. Check a config file sample:
+
+```yaml
+# default is: localhost
+host: 'some host'
+
+# default is: 3000
+port: 1234
+
+# either watch this files along with `app/assets` and `app/views`
+files:
+  - 'some/file/**/*.css'
+```
+
+## Problems?
+
+If something goes wrong with your setup, because of a NPM permission, you'll need to install browser-sync by yourself:
+
+```sh
+sudo npm install -g browser-sync
+```
+
+------
+
+Any others, please create a issue about.
+
+## Contributing
+
+Feel free to open a Pull Request or open issues. 😄

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'BrowserSyncRails'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/browser_sync_rails.rb

@@ -0,0 +1,4 @@
+require_relative 'browser_sync_rails/railtie'
+
+module BrowserSyncRails
+end

data/lib/browser_sync_rails/railtie.rb

@@ -0,0 +1,9 @@
+require 'rails'
+
+module BrowserSyncRails
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      Dir[File.join(__dir__, '../tasks/*.rake')].each { |f| load f }
+    end
+  end
+end

data/lib/browser_sync_rails/runner.rb

@@ -0,0 +1,30 @@
+module BrowserSyncRails
+  class Runner
+    def initialize(options={})
+      @options = options
+    end
+
+    def cli_command
+      "browser-sync start --proxy #{host}:#{port} --files '#{files}'"
+    end
+
+    private
+
+    def host
+      @options[:host] || 'localhost'
+    end
+
+    def port
+      @options[:port] || '3000'
+    end
+
+    def files
+      files = ['app/assets', 'app/views']
+      if @options[:files]
+        (files | @options[:files]).join(', ')
+      else
+        files.join(', ')
+      end
+    end
+  end
+end

data/lib/browser_sync_rails/version.rb

@@ -0,0 +1,3 @@
+module BrowserSyncRails
+  VERSION = "0.1.0"
+end

data/lib/generators/browser_sync_rails/install_generator.rb

@@ -0,0 +1,41 @@
+require 'rails/generators/base'
+
+module BrowserSyncRails
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc "Install the browser sync"
+
+      def setup
+        unless exist_command? 'npm'
+          puts 'You should have Node installed to continue. Download page: https://nodejs.org/en/download/'
+          puts 'Or you can also install via NVM - Node Version Manager -. Check it out: https://github.com/creationix/nvm'
+          exit
+        end
+
+        unless exist_command? 'browser-sync'
+          puts 'Installing browser sync. Just a moment.'
+          exec 'npm i -g browser-sync'
+        end
+
+        create_file "config/browser_sync.yml"
+      end
+
+      private
+
+      def which(cmd)
+        exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+        ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+          exts.each { |ext|
+            exe = File.join(path, "#{cmd}#{ext}")
+            return exe if File.executable?(exe) && !File.directory?(exe)
+          }
+        end
+        return nil
+      end
+
+      def exist_command?(cmd)
+        which(cmd) != nil
+      end
+    end
+  end
+end

data/lib/tasks/browser_sync_rails_tasks.rake

@@ -0,0 +1,20 @@
+require 'browser_sync_rails/runner'
+require 'yaml'
+
+namespace :browser_sync do
+  desc "Starts browser sync"
+  task :start do
+    path = Rails.root.join('config', 'browser_sync.yml')
+
+    options = if File.exist? path
+      config = YAML.load_file(path)
+      config = {} unless config
+      config.symbolize_keys
+    else
+      {}
+    end
+
+    runner = BrowserSyncRails::Runner.new(options)
+    sh runner.cli_command
+  end
+end

data/test/browser_sync_rails_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class BrowserSyncRailsTest < ActiveSupport::TestCase
+  test "truth" do
+    assert_kind_of Module, BrowserSyncRails
+  end
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application', __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/bin/setup

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+
+Dir.chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file:
+
+  puts "== Installing dependencies =="
+  system "gem install bundler --conservative"
+  system "bundle check || bundle install"
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?("config/database.yml")
+  #   system "cp config/database.yml.sample config/database.yml"
+  # end
+
+  puts "\n== Preparing database =="
+  system "bin/rake db:setup"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system "rm -f log/*"
+  system "rm -rf tmp/cache"
+
+  puts "\n== Restarting application server =="
+  system "touch tmp/restart.txt"
+end

data/test/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment', __FILE__)
+run Rails.application

data/test/dummy/config/application.rb

@@ -0,0 +1,26 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "browser_sync_rails"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Do not swallow errors in after_commit/after_rollback callbacks.
+    config.active_record.raise_in_transactional_callbacks = true
+  end
+end
+