check_files 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 289d84e6d22f2ce0f546cb2d8b2a9af7614413da
+  data.tar.gz: 9f3f0fa230535ab8ff0e3f898598d3ef41c386df
+SHA512:
+  metadata.gz: e875d93fcd9b6dbee5a9e80a23bfeec8e714167ff4c5a34938da551d87d116b300ee54e37957d7a5db581eef0b1be4f41c086000ecde7ba4afce34bbf3ca7802
+  data.tar.gz: 839b099d814b6ed4e3d7600561c0082eb242b466baa01f7c0e13b19dc7dc978f0a98aa6a6cabf2834d0534e122c99248e694d9b3e8ceb8b27418f8d4b200ce21

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/log

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+cache: bundler
+sudo: false
+rvm:
+- 2.3.1
+before_install: gem install bundler
+notifications:
+  email: false
+env:
+  global:
+    secure: kYFQh6ljbxCjeVSblngOY+50qRbSigK/P+osQfxgAe0e5NLV14zUqChCnS8ipdPP86HyNxBLJlFlu08fEXmQSwQUd+7j87TWR6v9+UFebmvmMrewRdmcKgFJZI/cu9CP6dAc7Lh3mD/WPQOTuEDx7boXhkc3FCBIaDLtdcva2OrD6AFzfjWvZEPYC40OEZdLbpnkKEd8uOfYkd+vX7eUAhtlsXbXd5ZX9j55CbdXeVPhzI1GKbWQYWF5K0lQYgY+FBke6SmN8X7XjVIF0McA72X9V0I3xyjTEr0Rm/8JPnMXC9F5o8Rqh3sKkF2vRUhAZw9nvZI7BjZJhiudyrR7/JX+ErkLpFgNUqz6wBPsWBRv4zn25atdDIMHs5hYRVyPpLl0xtNKnJwUd6m/6aeUGP0B6x80sDx4CPVPSeFpJ+NbND2KYHxi9Aw2KqKwOBcZWVDwAjecewpUOJlnMX+3/g24FXkmFICc4zaJazCPiW6T2GR/YwIZiu0c5oapX/tU2QfNMZHY/6leFIcYc1mX5bLoaaYSuYKizncJe4EJnyEp5myapDq2mVYCol3HmhkgQ8Bd8T8WxLrFv1954xkd/npFMov+bHrnt5Cypbr+qTocnVHSA968m8YCTyNjzU5fvJgZweQKsFK1sPGHgHGiKlBeKc5syJo7QbH8N+j7VRc=

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at fnando.vieira@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Nando Vieira
+
+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,76 @@
+# CheckFiles
+
+[![Travis-CI](https://travis-ci.org/fnando/check_files.png)](https://travis-ci.org/fnando/check_files)
+[![Code Climate](https://codeclimate.com/github/fnando/check_files/badges/gpa.svg)](https://codeclimate.com/github/fnando/check_files)
+[![Test Coverage](https://codeclimate.com/github/fnando/check_files/badges/coverage.svg)](https://codeclimate.com/github/fnando/check_files/coverage)
+[![Gem](https://img.shields.io/gem/v/check_files.svg)](https://rubygems.org/gems/check_files)
+[![Gem](https://img.shields.io/gem/dt/check_files.svg)](https://rubygems.org/gems/check_files)
+
+Ever forgot to restart the development web server when you change things like `Gemfile` or `config/environments/development.rb`? You're not alone. There are a lot of cases to keep in mind:
+
+- You upgrade and/or remove/add gems to `Gemfile`.
+- You change environment values (e.g. `config/environments/development.rb`).
+- You change initializer values.
+- You add/remove directories to/from `app`.
+- You add/remove files to/from `config/locales`.
+- You change configuration files living at `config/*.yml` .
+
+With this gem you don't have to think about it. Every time you change files that require a restart, an exception will be raised and you'll know what you have to do.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "check_files", group: :development
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install check_files
+
+## Usage
+
+You don't have to configure anything but there are some configurable values if you want. The following values are the defaults:
+
+```ruby
+# The list of files/directories that must be checked.
+# Patterns ended with /* will just check the entries list (not the content).
+config.check_files.paths = [
+  "Gemfile.lock",
+  "config/initializers/**/*.rb",
+  "config/{application,boot,config,environment}.rb",
+  "config/*.yml",
+  "config/environments/**/*.rb",
+  "app/*",
+  "config/locales/**/*"
+]
+
+# The notifier that will be used. By default it raises an exception on Rails < 5 or restarts the web server (Rails 5+).
+# You can use CheckFiles::Notifiers::Exception, CheckFiles::Notifiers::Logging or CheckFiles::Notifiers::Restart (Rails 5+).
+config.check_files.notifier = CheckFiles::Notifiers::Exception
+```
+
+To overwrite any of these values, just create the initializer `config/initializers/check_files.rb` like the following:
+
+```ruby
+Rails.configuration.check_files.notifier = CheckFiles::Notifiers::Logging
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/fnando/check_files. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.warning = false
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "check_files"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/check_files.gemspec

@@ -0,0 +1,25 @@
+require "./lib/check_files/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "check_files"
+  spec.version       = CheckFiles::VERSION
+  spec.authors       = ["Nando Vieira"]
+  spec.email         = ["fnando.vieira@gmail.com"]
+
+  spec.summary       = "Check non-reloadable files changes on Rails apps"
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/fnando/check_files"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest-utils"
+  spec.add_development_dependency "rails"
+  spec.add_development_dependency "pry-meta"
+  spec.add_development_dependency "codeclimate-test-reporter"
+end

data/lib/check_files.rb

@@ -0,0 +1,28 @@
+require "rails/railtie"
+
+module CheckFiles
+  require "check_files/version"
+  require "check_files/railtie"
+  require "check_files/middleware"
+  require "check_files/checker"
+  require "check_files/notifiers/logging"
+  require "check_files/notifiers/exception"
+  require "check_files/notifiers/restart"
+
+  def self.config
+    Rails.application.config.check_files
+  end
+
+  def self.checkers
+    @checkers ||= config.paths.map {|path| Checker.new(path) }
+  end
+
+  def self.reset
+    @checkers = nil
+  end
+
+  def self.check!
+    change = checkers.find(&:changed?)
+    config.notifier.call(change) if change
+  end
+end

data/lib/check_files/checker.rb

@@ -0,0 +1,46 @@
+module CheckFiles
+  class Checker
+    attr_reader :cache_path, :pattern
+
+    def initialize(pattern)
+      @pattern = pattern
+      pattern_digest = Digest::SHA1.hexdigest(pattern)
+      @cache_path = Rails.root.join("tmp/cache/#{pattern_digest}")
+    end
+
+    def current_digest
+      entries = Dir[pattern].sort
+      entries_digest = Digest::SHA1.hexdigest(entries.join)
+
+      if pattern.end_with?("/*")
+        entries_digest
+      else
+        content_digest = entries.map {|entry| compute_digest(entry) }.join
+        Digest::SHA1.hexdigest("#{entries_digest}#{content_digest}")
+      end
+    end
+
+    def previous_digest
+      cache_path.file? && cache_path.read
+    end
+
+    def changed?
+      prev_digest = previous_digest
+
+      if prev_digest
+        prev_digest != current_digest
+      else
+        update_cache && false
+      end
+    end
+
+    def update_cache
+      File.open(cache_path, "w") {|f| f << current_digest }
+    end
+
+    def compute_digest(entry)
+      content = File.exist?(entry) && File.read(entry)
+      Digest::SHA1.hexdigest("#{entry}-#{content}")
+    end
+  end
+end

data/lib/check_files/middleware.rb

@@ -0,0 +1,16 @@
+module CheckFiles
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      CheckFiles.check! unless asset?(env)
+      @app.call(env)
+    end
+
+    def asset?(env)
+      env["REQUEST_PATH"] =~ /\.(css|js|jpe?g|gif|svg|ico|swf|html)/
+    end
+  end
+end

data/lib/check_files/notifiers/exception.rb

@@ -0,0 +1,9 @@
+module CheckFiles
+  module Notifiers
+    class Exception
+      def self.call(checker)
+        fail "You must restart the web development server; #{checker.pattern} has changed."
+      end
+    end
+  end
+end

data/lib/check_files/notifiers/logging.rb

@@ -0,0 +1,9 @@
+module CheckFiles
+  module Notifiers
+    class Logging
+      def self.call(checker)
+        $stderr << "\n\e[0;31m=> You must restart your web development server; #{checker.pattern} has changed.\e[0m\n"
+      end
+    end
+  end
+end

data/lib/check_files/notifiers/restart.rb

@@ -0,0 +1,10 @@
+module CheckFiles
+  module Notifiers
+    class Restart < Logging
+      def self.call(checker)
+        $stderr << "\n\e[0;31m=> #{checker.pattern} has changed, so the web server was restarted. Please reload the page.\e[0m\n"
+        system "rails restart"
+      end
+    end
+  end
+end

data/lib/check_files/railtie.rb

@@ -0,0 +1,28 @@
+module CheckFiles
+  class Railtie < Rails::Railtie
+    config.check_files = ActiveSupport::OrderedOptions.new
+
+    initializer "check_files" do
+      config.check_files.paths = [
+        "Gemfile.lock",
+        "config/initializers/**/*.rb",
+        "config/{application,boot,config,environment}.rb",
+        "config/*.yml",
+        "config/environments/**/*.rb",
+        "app/*",
+        "config/locales/**/*"
+      ]
+
+      Rails.application.config.middleware.use(Middleware)
+      config.check_files.notifier = if Rails::VERSION::STRING >= "5.0.0"
+                                      Notifiers::Restart
+                                    else
+                                      Notifiers::Exception
+                                    end
+
+      Rails.application.config.after_initialize do
+        CheckFiles.checkers.each(&:update_cache)
+      end
+    end
+  end
+end

data/lib/check_files/version.rb

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

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: check_files
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nando Vieira
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-utils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-meta
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Check non-reloadable files changes on Rails apps
+email:
+- fnando.vieira@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- check_files.gemspec
+- lib/check_files.rb
+- lib/check_files/checker.rb
+- lib/check_files/middleware.rb
+- lib/check_files/notifiers/exception.rb
+- lib/check_files/notifiers/logging.rb
+- lib/check_files/notifiers/restart.rb
+- lib/check_files/railtie.rb
+- lib/check_files/version.rb
+homepage: https://github.com/fnando/check_files
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Check non-reloadable files changes on Rails apps
+test_files: []