RubyGems - watchit - Versions diffs - 1.0.0 - Mend

watchit 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (19) hide show

checksums.yaml +7 -0
data/.gitignore +9 -0
data/.travis.yml +4 -0
data/Gemfile +4 -0
data/README.md +15 -0
data/Rakefile +1 -0
data/avatar.jpg +0 -0
data/bin/console +8 -0
data/bin/watchit +36 -0
data/demo.html +6 -0
data/lib/watchit.rb +50 -0
data/lib/watchit/auto_refresh.js +18 -0
data/lib/watchit/file_system.rb +33 -0
data/lib/watchit/injection.rb +29 -0
data/lib/watchit/render.rb +12 -0
data/lib/watchit/version.rb +3 -0
data/lib/watchit/views/file_list.erb +12 -0
data/watchit.gemspec +26 -0
metadata +132 -0

checksums.yaml ADDED

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8de94659ec9c15c23c2575ec1bd5aef8d44bad38
+  data.tar.gz: dd797351e7744ae574baf4741b3d45102867d550
+SHA512:
+  metadata.gz: db69f4e4d9461610d322480a09371084d07997a4552d68b13d53d9ae5b1e220771dc30506954aba004c7affeddedb173a12bbb7f302b6c4120a3c6c609c6ff53
+  data.tar.gz: 8f3709c983976592e5b6894dac59f23c7027b498f59d6b4ebaa2cd4efb16e8a4c9a5bef885a6d0c20561f6852de7c9efae1728a6981f15c010f7a4504036e581

data/.gitignore ADDED

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

data/.travis.yml ADDED

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.4
+before_install: gem install bundler -v 1.10.6

data/Gemfile ADDED

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+# Specify your gem's dependencies in watchit.gemspec
+gemspec

data/README.md ADDED

@@ -0,0 +1,15 @@
+# watchit
+watchit是一个前端开发的辅助工具，其主要功能有：
+- 在指定目录下启动一个静态web服务器，用于向浏览器提供静态文件访问（效果与python3 -m http.server相同）
+- 监视启动web服务器的目录中任意文件的修改操作，当有修改时自动刷新页面
+# 基本使用
+```
+Usage: watchit [options]
+    -w, --watch        Watch path, 要监视的路径
+    -p, --port         Server port, 启动的服务器端口
+    -v, --version      Version, 版本信息
+    -h, --help         Display this help message, 帮助消息
+```

data/Rakefile ADDED

	@@ -0,0 +1 @@
1	+ require "bundler/gem_tasks"

data/avatar.jpg ADDED

Binary file

data/bin/console ADDED

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+require "bundler/setup"
+require "watchit"
+# 进入pry调试环境
+require "pry"
+Pry.start

data/bin/watchit ADDED

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+require "bundler/setup"
+require "slop"
+require "sinatra/base"
+module Watchit
+    # 入参解析
+    opts = Slop.parse({ help: true, strict: true }) do
+      banner 'Usage: watchit [options]'
+      on 'w=', 'watch=', 'Watch path'
+      on 'p=', 'port=', 'Server port'
+      on 'v', 'version', 'Version' do
+    	  puts Slop::VERSION
+          exit
+      end
+    end
+    # 监视路径与端口
+    Watch_path = File.absolute_path(opts[:watch] || Dir.pwd) # 绝对路径
+    Watch_port = opts[:port] || 8080
+    # 配置
+    class WatchitApp < Sinatra::Application
+        configure do
+            # set :public_folder, Watchit::Watch_path
+            set :port, Watchit::Watch_port
+            set :views, File.expand_path('../../lib/watchit/views', __FILE__)
+        end
+    end
+    # 启动Watchit服务器
+    # 本句会在require_paths中搜索
+    require 'watchit'
+end

data/demo.html ADDED

@@ -0,0 +1,6 @@
+<!DOCTYPE>
+<html>
+<body>
+	<h3>Have a nice day!</h3>
+</body>
+<html>

data/lib/watchit.rb ADDED

@@ -0,0 +1,50 @@
+require 'erb'
+require 'json'
+require "watchit/version"
+require 'sinatra/base'
+require 'watchit/injection'
+require 'watchit/render'
+require 'watchit/file_system'
+module Watchit
+    class WatchitApp < Sinatra::Application
+        include Watchit::Injection
+        include Watchit::Render
+        include Watchit::FileSystem
+        get '/mtime' do
+            content_type :json
+            {:mtime => dir_mtime(Watchit::Watch_path).serilize}.to_json
+        end
+        get '/*' do
+            # 请求路径
+            request_file_path = params[:splat][0]
+            # 文件实际位置
+            location = File.expand_path request_file_path, Watchit::Watch_path
+            # 扩展名
+            regex_start = (/.*\.(\w+)/ =~ request_file_path)
+            if File.directory? location
+                return file_list_html(location)
+            end
+            # 为html文件插入js脚本
+            if regex_start != nil && $1 == 'html'
+                file = File.open location
+                content = file.read
+                file.close
+                content_type :html
+                # 注入文本
+                inject content
+            # 不需要插入，直接返回文件内容
+            else
+                send_file location
+            end
+        end
+        # 启动服务器
+        run!
+    end
+end

data/lib/watchit/auto_refresh.js ADDED

@@ -0,0 +1,18 @@
+// var matchingPath = '{{WATCHING_PATH}}';
+var modifiedTime = '{{MODIFIED_TIME}}';
+// alert('Hi this is from the auto-refresh script!')
+var xhr = new XMLHttpRequest();
+xhr.addEventListener("load", function(){
+	var mtime = JSON.parse(this.responseText).mtime;
+	if( mtime !== modifiedTime ){
+		location.reload();
+	}
+});
+document.addEventListener("visibilitychange", function handleVisibilityChange() {
+	if(document.hidden) return;
+	xhr.open("GET", "/mtime");
+	xhr.send();
+}, false);

data/lib/watchit/file_system.rb ADDED

@@ -0,0 +1,33 @@
+module Watchit
+	module FileSystem
+		def dir_mtime(dir_name)
+			old_dir = Dir.pwd
+			Dir.chdir dir_name
+			# 最新修改时间
+			lastest = Time.at(0)
+			file_names = Dir.entries('.').select{|name| !name.start_with? '.'}
+			file_names.each do |file_name|
+				next if File.symlink? file_name # 忽略软连接
+				# 普通文件
+				if !File.directory?(file_name)
+					mtime = File.mtime file_name
+				# 目录
+				else
+					mtime = dir_mtime file_name
+				end
+				lastest = mtime if lastest < mtime
+			end
+			def lastest.serilize
+				"#{self.year}/#{self.month}/#{self.day}/#{self.hour}/#{self.min}/#{self.sec}"
+			end
+			Dir.chdir old_dir
+			return lastest
+		end
+	end
+end

data/lib/watchit/injection.rb ADDED

@@ -0,0 +1,29 @@
+require 'watchit/file_system'
+module Watchit
+	module Injection
+		include Watchit::FileSystem
+		# 向给定html文本中注入自动刷新html脚本
+		def inject(raw_html)
+			insert_index = (/<\/body>/ =~ raw_html)
+			raw_html.insert insert_index, "<script>#{auto_refresh_script}</script>"
+		end
+		# 获取自动刷新js脚本代码
+		def auto_refresh_script
+			script_file = File.open File.expand_path('../auto_refresh.js', __FILE__)
+			# 监视路径的修改时间
+			mtime = dir_mtime Watchit::Watch_path
+			time_str = mtime.serilize
+			script = script_file.read
+			script = script.sub(/{{MODIFIED_TIME}}/, time_str)
+			 				.sub(/{{WATCHING_PATH}}/, Watchit::Watch_path)# 设置修改时间
+			script_file.close
+			return script
+		end
+	end
+end

data/lib/watchit/render.rb ADDED

@@ -0,0 +1,12 @@
+module Watchit
+	module Render
+		def file_list_html(path)
+			file_list = Dir.entries(path)
+                .select{|name| !name.start_with? '.'}
+            erb :file_list, :locals => {
+				:path => path,
+                :file_list => file_list
+            }
+		end
+	end
+end

data/lib/watchit/version.rb ADDED

@@ -0,0 +1,3 @@
+module Watchit
+  VERSION = "1.0.0"
+end

data/lib/watchit/views/file_list.erb ADDED

@@ -0,0 +1,12 @@
+<!DOCTYPE>
+<html>
+<body>
+	<p>Welcome to Wathit!</p>
+	<p>Files(directories) under [<%=path%>]:</p>
+	<ul>
+		<% file_list.each do |file| %>
+			<li><a href=./<%=file%>><%=file%></a></li>
+		<% end %>
+	</ul>
+</body>
+</html>

data/watchit.gemspec ADDED

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'watchit/version'
+Gem::Specification.new do |spec|
+    spec.name          = "watchit"
+    spec.version       = Watchit::VERSION
+    spec.authors       = ["luminocean"]
+    spec.email         = ["282896922@qq.com"]
+    spec.summary       = 'Frontend modification listening and auto-refreshing tool'
+    spec.files         = `git ls-files -z`.split("\x0")
+    spec.bindir        = "bin"
+    spec.executables   = ["watchit"]
+    spec.require_paths = ["lib"]
+    spec.license       = 'MIT'
+    spec.homepage         = 'https://github.com/luminocean/watchit'
+    spec.add_dependency "sinatra", "~> 1.4"
+    spec.add_dependency "slop", "~> 3.4"
+    spec.add_development_dependency "bundler", "~> 1.10"
+    spec.add_development_dependency "rake", "~> 11.1.2"
+    spec.add_development_dependency "pry", "~> 0.10"
+end

metadata ADDED

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: watchit
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- luminocean
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2016-04-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 11.1.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 11.1.2
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description:
+email:
+- 282896922@qq.com
+executables:
+- watchit
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- avatar.jpg
+- bin/console
+- bin/watchit
+- demo.html
+- lib/watchit.rb
+- lib/watchit/auto_refresh.js
+- lib/watchit/file_system.rb
+- lib/watchit/injection.rb
+- lib/watchit/render.rb
+- lib/watchit/version.rb
+- lib/watchit/views/file_list.erb
+- watchit.gemspec
+homepage: https://github.com/luminocean/watchit
+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.4.5.1
+signing_key:
+specification_version: 4
+summary: Frontend modification listening and auto-refreshing tool
+test_files: []