mcc 0.1.0

data/.document

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

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Kuniaki IGARASHI
+
+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

@@ -0,0 +1,17 @@
+= mcc
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Kuniaki IGARASHI. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "mcc"
+    gem.summary = %Q{Magic Comment Checker}
+    gem.description = %Q{It provides command "mcc" for check a magic comment. }
+    gem.email = "igaiga@gmail.com"
+    gem.homepage = "http://github.com/igaiga/mcc"
+    gem.authors = ["Kuniaki IGARASHI"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "mcc #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/mcc

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(dir) unless $LOAD_PATH.include?(dir)
+require 'mcc'
+
+MCC.run(ARGV)

data/lib/mcc.rb

@@ -0,0 +1,50 @@
+# coding: utf-8
+
+require 'tempfile'
+require 'fileutils'
+
+module MCC
+  RE = /^#.*coding.*:.*$/
+
+  def self.run(files, format = '# coding: utf-8')
+    files.each do |file|
+      unless include_magick_comment?(file)
+        insert_magick_comment(file, format)
+      end
+    end
+  end
+
+  def self.include_magick_comment?(file)
+    File.open(file) do |f|
+      2.times do
+        f.readline =~ RE and return true
+      end
+    end
+    false
+  end
+
+  def self.insert_magick_comment(file, magick_comment)
+    include_shebang = include_shebang?(file)
+
+    tmp = Tempfile.open(File.basename(file))
+    File.open(file) do |f|
+      tmp.puts f.readline if include_shebang
+      tmp.puts magick_comment
+
+      f.each do |line|
+        tmp.puts line
+      end
+    end
+    tmp.flush
+
+    FileUtils.cp(tmp, file)
+  ensure
+    tmp.close
+  end
+
+  def self.include_shebang?(file)
+    File.open(file) do |f|
+      return !!(f.readline  =~ /^#!/)
+    end
+  end
+end

data/spec/fixtures/with_magick_comment.rb

@@ -0,0 +1,5 @@
+# coding: utf-8
+
+# this is Foo
+class Foo
+end

data/spec/fixtures/with_shebang_and_magick_comment.rb

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# coding: utf-8
+
+# this is Foo
+class Foo
+end

data/spec/fixtures/without_magick_comment.rb

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+# this is Foo
+class Foo
+end

data/spec/fixtures/without_shebung_and_magick_comment.rb

@@ -0,0 +1,3 @@
+# this is Foo
+class Foo
+end

data/spec/mcc_spec.rb

@@ -0,0 +1,50 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'tempfile'
+
+describe "Mcc" do
+  it "should run" do
+    MCC.should_receive(:include_magick_comment?).with('foo.rb')
+    MCC.should_receive(:include_magick_comment?).with('bar.rb')
+    MCC.should_receive(:insert_magick_comment).with('foo.rb', '# encoding: utf-8')
+    MCC.should_receive(:insert_magick_comment).with('bar.rb', '# encoding: utf-8')
+
+    MCC.run(['foo.rb', 'bar.rb'], '# encoding: utf-8')
+  end
+
+  it 'should check to include a magick comment' do
+    {
+      'with_magick_comment.rb'             => true,
+      'without_magick_comment.rb'          => false,
+      'with_shebang_and_magick_comment.rb' => true
+    }.each do |k, v|
+      MCC.include_magick_comment?(fixture_file(k)).should be v
+    end
+  end
+
+  it 'should insert a magick comment' do
+    {
+      'without_magick_comment.rb' => true,
+      'without_shebung_and_magick_comment.rb' => false
+    }.each do |file, include_shebang|
+      begin
+        tmp = Tempfile.open(file)
+        FileUtils.cp(fixture_file(file), tmp.path)
+        MCC.insert_magick_comment(tmp.path, '# encoding: utf-8')
+
+        MCC.include_magick_comment?(tmp.path).should be true
+        MCC.include_shebang?(tmp.path).should be include_shebang
+      ensure
+        tmp.close
+      end
+    end
+  end
+
+  it 'should check include a shebang' do
+    MCC.include_shebang?(fixture_file('with_shebang_and_magick_comment.rb')).should be true
+    MCC.include_shebang?(fixture_file('with_magick_comment.rb')).should be false
+  end
+
+  def fixture_file(filename)
+    File.join(File.dirname(__FILE__), 'fixtures', filename)
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'mcc'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification 
+name: mcc
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Kuniaki IGARASHI
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-10 00:00:00 +09:00
+default_executable: mcc
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+description: "It provides command \"mcc\" for check a magic comment. "
+email: igaiga@gmail.com
+executables: 
+- mcc
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/mcc
+- lib/mcc.rb
+- spec/fixtures/with_magick_comment.rb
+- spec/fixtures/with_shebang_and_magick_comment.rb
+- spec/fixtures/without_magick_comment.rb
+- spec/fixtures/without_shebung_and_magick_comment.rb
+- spec/mcc_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/igaiga/mcc
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Magic Comment Checker
+test_files: 
+- spec/fixtures/with_magick_comment.rb
+- spec/fixtures/with_shebang_and_magick_comment.rb
+- spec/fixtures/without_magick_comment.rb
+- spec/fixtures/without_shebung_and_magick_comment.rb
+- spec/mcc_spec.rb
+- spec/spec_helper.rb