lock_block 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rbenv-version

@@ -0,0 +1 @@
+1.9.3-p194

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Joe Nelson
+
+MIT License
+
+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,72 @@
+# Lock Block
+
+Mark sections of Ruby code as important. Check if these sections
+have changed.  The difference checking intelligently ignores code
+formatting.
+
+## Usage
+
+Installing this gem provides a command line program to annotate Ruby
+code.
+
+`lock_block [options] [filename]`
+
+If a file is not specified, the program will read from STDIN.
+
+<table>
+  <caption>Options</caption>
+<tbody>
+  <tr>
+    <td>--lock, -l</td>
+    <td>(default) Lock the block. Wraps code in tagged annotation.</td>
+  </tr>
+  <tr>
+    <td>--check, -c</td>
+    <td>List all blocks thare are outdated.</td>
+  </tr>
+  <tr>
+    <td>--resolve, -r</td>
+    <td>Update tags in annotation to mark blocks as up to date.</td>
+  </tr>
+</tbody>
+</table>
+
+## Vim Configuration
+
+Lock Block is good on its own but better with Vim. Add the
+following to your `~/.vimrc`:
+
+    function! LockBlockCheck(arg)
+      let tmp1=&grepprg
+      set grepprg=lock_block
+      exe "silent! grep -c ".a:arg
+      exe "cw"
+      let &grepprg=tmp1
+    endf
+    command! -nargs=1 LBCheck call LockBlockCheck(<f-args>)
+    " Check for broken locks in current file
+    nmap <leader>lc :LBCheck %<CR>
+    
+    " Lock selected block
+    vmap <silent> <Leader>ll !lock_block<CR>
+    " Resolved selected blocks
+    vmap <silent> <Leader>lr !lock_block -r<CR>
+
+This will give you three commands:
+
+<table>
+<tbody>
+  <tr>
+    <td>&lt;leader&gt;lc</td>
+    <td>Check the current file, open problems in quicklist.</td>
+  </tr>
+  <tr>
+    <td>&lt;leader&gt;ll</td>
+    <td>Replace selection with locked version.</td>
+  </tr>
+  <tr>
+    <td>&lt;leader&gt;lr</td>
+    <td>Resolve all blocks in selected region.</td>
+  </tr>
+</tbody>
+</table>

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = "test/*_spec.rb"
+end
+
+task default: [:test]

data/bin/lock_block

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+require 'lock_block'
+require 'trollop'
+
+opts = Trollop::options do
+  opt :lock,    "Annotate input with lock hash", default: true
+  opt :check,   "Check input for broken locks"
+  opt :resolve, "Update all lock tags in input"
+end
+
+input = ARGF.read
+if opts[:check]
+  errs = LockBlock.broken_locks input
+  if errs.any?
+    errs.each do |error|
+      puts [ARGF.path, error[:line], error[:got]].join ':'
+    end
+    exit 1
+  end
+elsif opts[:resolve]
+  puts LockBlock.resolve input
+else
+  puts LockBlock.lock input
+end

data/lib/lock_block/version.rb

@@ -0,0 +1,3 @@
+module LockBlock
+  VERSION = "0.0.1"
+end

data/lib/lock_block.rb

@@ -0,0 +1,53 @@
+require 'lock_block/version'
+require 'ripper'
+require 'digest/sha1'
+
+module LockBlock
+  def LockBlock.lock source
+    indent = source.match(/^(\s+)/) ? $1 : ''
+    tag    = tag source
+    "#{indent}# lock do #{tag}\n#{source}#{indent}# lock end #{tag}"
+  end
+
+  def LockBlock.resolve source
+    tags(source).each do |tag|
+      resolved_tag = tag innards(source, tag)
+      source = update_tag source, tag, resolved_tag
+    end
+    source
+  end
+
+  def LockBlock.broken_locks source
+    broken = []
+    source.lines.each_with_index do |line, number|
+      if tags(line).any?
+        got      = tags(line).first
+        expected = tag innards(source, got)
+        if got != expected
+          broken.push({line: number+1, expected: expected, got: got})
+        end
+      end
+    end
+    broken
+  end
+
+  def LockBlock.tag source
+    tokens = Ripper.tokenize(source).select do |t|
+      t.gsub(/\s+/, "") != ''
+    end
+    Digest::SHA1.hexdigest tokens.to_s
+  end
+
+  def LockBlock.tags source
+    source.scan(/# lock do ([a-f0-9]{40})/).map &:first
+  end
+
+  def LockBlock.update_tag source, old_tag, new_tag
+    source.gsub /# lock (do|end) #{old_tag}/, "# lock \\1 #{new_tag}"
+  end
+
+  def LockBlock.innards source, tag
+    match = source.match /# lock do #{tag}\n(.*?)# lock end #{tag}/m
+    match ? match[1] : ''
+  end
+end

data/lock_block.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lock_block/version'
+
+Gem::Specification.new do |gem|
+  gem.name                  = "lock_block"
+  gem.version               = LockBlock::VERSION
+  gem.authors               = ["Joe Nelson"]
+  gem.email                 = ["cred+github@begriffs.com"]
+  gem.description           = %q{Mark code blocks important, monitor them}
+  gem.summary               = %q{Provides command-line tool to annotate and check blocks of code}
+  gem.homepage              = "https://github.com/begriffs/lock_block"
+
+  gem.files                 = `git ls-files`.split($/)
+  gem.executables           = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files            = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths         = ["lib"]
+  gem.required_ruby_version = '>= 1.9'
+
+  gem.add_dependency 'trollop', '~> 2.0'
+end

data/test/lock_block_spec.rb

@@ -0,0 +1,92 @@
+require 'minitest/autorun'
+require 'lock_block'
+
+code_block = <<EOT
+def foo x
+  x + 1
+end
+EOT
+
+code_block_dedent = <<EOT
+def foo x
+x + 1
+end
+EOT
+
+code_block_outdated = <<EOT
+# stuff
+# lock do 0000000000000000000000000000000000000000
+1+1
+# lock end 0000000000000000000000000000000000000000
+# bother
+# lock do 0000000000000000000000000000000000000000
+1+2
+# lock end 0000000000000000000000000000000000000000
+EOT
+
+code_block_resolved = <<EOT
+# stuff
+# lock do 921fbda07b9630c541f486c666238d1c0d6384c8
+1+1
+# lock end 921fbda07b9630c541f486c666238d1c0d6384c8
+# bother
+# lock do 921fbda07b9630c541f486c666238d1c0d6384c8
+1+2
+# lock end 921fbda07b9630c541f486c666238d1c0d6384c8
+EOT
+
+describe LockBlock do
+  describe '#tag' do
+    it 'ignores spacing differences' do
+      LockBlock.tag('1+1').must_equal LockBlock.tag('1 + 1')
+    end
+
+    it 'respects constant differences' do
+      LockBlock.tag('1+1').wont_be_same_as LockBlock.tag('1+2')
+    end
+
+    it 'respects differing comments' do
+      LockBlock.tag('#hi').wont_be_same_as LockBlock.tag('#bye')
+    end
+
+    it 'ignores Ruby indentation' do
+      LockBlock.tag(code_block).must_equal LockBlock.tag(code_block_dedent)
+    end
+  end
+
+  describe '#lock' do
+    it 'wraps a block of code' do
+      code = "1+1\n"
+      h = LockBlock.tag code
+      wrapped_code = "# lock do #{h}\n1+1\n# lock end #{h}"
+      LockBlock.lock(code).must_equal wrapped_code
+    end
+    it 'matches indentation' do
+      code = "\t1+1\n"
+      h = LockBlock.tag code
+      wrapped_code = "\t# lock do #{h}\n\t1+1\n\t# lock end #{h}"
+      LockBlock.lock(code).must_equal wrapped_code
+    end
+    it 'leaves non-Ruby untouched' do
+      code         = "It isn't Ruby, is it?\n"
+      expected_tag = LockBlock.tag code
+      wrapped_code = "# lock do #{expected_tag}\n#{code}# lock end #{expected_tag}"
+      LockBlock.lock(code).must_equal wrapped_code
+    end
+  end
+
+  describe '#resolve' do
+    it 'updates the hash on a block and leaves other lines untouched' do
+      LockBlock.resolve(code_block_outdated).must_equal code_block_resolved
+    end
+  end
+
+  describe '#broken_locks' do
+    it 'finds line numbers of lock blocks that are outdated' do
+      errs = LockBlock.broken_locks code_block_outdated
+      errs.length.must_equal 2
+      errs[0][:line].must_equal 2
+      errs[1][:line].must_equal 6
+    end
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: lock_block
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Joe Nelson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: trollop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Mark code blocks important, monitor them
+email:
+- cred+github@begriffs.com
+executables:
+- lock_block
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rbenv-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/lock_block
+- lib/lock_block.rb
+- lib/lock_block/version.rb
+- lock_block.gemspec
+- test/lock_block_spec.rb
+homepage: https://github.com/begriffs/lock_block
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Provides command-line tool to annotate and check blocks of code
+test_files:
+- test/lock_block_spec.rb