file_classify 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2145249459482451c944d8510de554d92175533b
+  data.tar.gz: 1cad6de9ade4bcdca69d201063657e51c85d1db3
+SHA512:
+  metadata.gz: 6bded4aabd3bdd4fd4f2c83f3209a7d304b88898b58e670a82993683e40146d9dd5760a0c8dca8745dac301469324d298d12c42be6f655e7ce46510ec40439e9
+  data.tar.gz: 19c94ceccd39958acbad53dc4a2b1a8327f1c5e09bfd5b73a456d14b7c26f46290177b85457acb9ee18fe965159dad3664698d7443317f084b4cbe767d070c57

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/.rspec

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Ryan Caught
+
+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,29 @@
+# FileClassify
+
+Binary and ASCII classification for files
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'file_classify'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install file_classify
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/file_classify.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'file_classify/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "file_classify"
+  spec.version       = FileClassify::VERSION
+  spec.authors       = ["Ryan Caught"]
+  spec.email         = ["rcaught@gmail.com"]
+  spec.description   = %q{Binary and ASCII classification for files}
+  spec.summary       = spec.description
+  spec.homepage      = "https://github.com/rcaught/file_classify"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "awesome_print"
+end

data/lib/file_classify.rb

@@ -0,0 +1,42 @@
+require "file_classify/version"
+require 'tempfile'
+
+class FileClassify
+  attr_accessor :contents, :path
+
+  def initialize(file_options = {})
+    raise ArgumentError if [:contents, :path].none? { |x| file_options.include?(x) }
+
+    @contents = file_options[:contents]
+    @path = file_options[:path]
+  end
+
+  # Based off the binary? method from ptools
+  # https://github.com/djberg96/ptools/blob/a43e133b4ee10750c0d4a7f68ab5be92269bbb56/lib/ptools.rb#L78
+  def binary?
+    file_path = self.path
+
+    if self.contents
+      temp = Tempfile.new('block_size_check')
+      temp.write(self.contents)
+      temp.close
+
+      file_path = temp.path
+    end
+
+    s = (File.read(file_path, File.stat(file_path).blksize) || "").split(//)
+    return ((s.size - s.grep(" ".."~").size) / s.size.to_f) > 0.30
+  end
+
+  def ascii?
+    self.binary? ? false : true
+  end
+
+  def classify
+    if self.binary?
+      return 'binary'
+    else
+      return 'ascii'
+    end
+  end
+end

data/lib/file_classify/version.rb

@@ -0,0 +1,3 @@
+class FileClassify
+  VERSION = "0.0.1"
+end

data/spec/lib/file_classify_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+require 'file_classify'
+
+BINARY_FILE = 'spec/resources/binary.jpg'
+ASCII_FILE = 'spec/resources/ascii.txt'
+
+describe FileClassify do
+  let :binary_contents_subject do
+    FileClassify.new(contents: File.read(BINARY_FILE))
+  end
+
+  let :binary_path_subject do
+    FileClassify.new(path: BINARY_FILE)
+  end
+
+  let :ascii_contents_subject do
+    FileClassify.new(contents: File.read(ASCII_FILE))
+  end
+
+  let :ascii_path_subject do
+    FileClassify.new(path: ASCII_FILE)
+  end
+
+  context '#initialize' do
+    it 'path' do
+      fc = FileClassify.new(path: BINARY_FILE)
+      fc.path.should == BINARY_FILE
+    end
+
+    it 'contents' do
+      fc = FileClassify.new(contents: File.read(BINARY_FILE))
+      fc.contents.should == File.read(BINARY_FILE)
+    end
+
+    it 'no args' do
+      expect { FileClassify.new }.to raise_error(ArgumentError)
+    end
+  end
+
+  context '#classify' do
+    it 'binary' do
+      binary_contents_subject.classify.should == 'binary'
+      binary_path_subject.classify.should == 'binary'
+    end
+
+    it 'ascii' do
+      ascii_contents_subject.classify.should == 'ascii'
+      ascii_path_subject.classify.should == 'ascii'
+    end
+  end
+
+  context '#binary?' do
+    it 'binary' do
+      binary_contents_subject.binary?.should be_true
+      binary_path_subject.binary?.should be_true
+    end
+
+    it 'ascii' do
+      ascii_contents_subject.binary?.should be_false
+      ascii_path_subject.binary?.should be_false
+    end
+  end
+
+  context '#ascii?' do
+    it 'ascii' do
+      ascii_contents_subject.ascii?.should be_true
+      ascii_path_subject.ascii?.should be_true
+    end
+
+    it 'binary' do
+      binary_contents_subject.ascii?.should be_false
+      binary_path_subject.ascii?.should be_false
+    end
+  end
+end

data/spec/resources/ascii.txt

@@ -0,0 +1,22 @@
+Stopping by Woods on a Snowy Evening
+Robert Frost
+
+Whose woods these are I think I know.
+His house is in the village, though;
+He will not see me stopping here
+To watch his woods fill up with snow.
+
+My little horse must think it queer
+To stop without a farmhouse near
+Between the woods and frozen lake
+The darkest evening of the year.
+
+He gives his harness bells a shake
+To ask if there is some mistake.
+The only other sound's the sweep
+Of easy wind and downy flake.
+
+The woods are lovely, dark, and deep,
+But I have promises to keep,
+And miles to go before I sleep,
+And miles to go before I sleep.

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'coveralls'
+Coveralls.wear!

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: file_classify
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ryan Caught
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: rspec
+  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: coveralls
+  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: awesome_print
+  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: Binary and ASCII classification for files
+email:
+- rcaught@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- file_classify.gemspec
+- lib/file_classify.rb
+- lib/file_classify/version.rb
+- spec/lib/file_classify_spec.rb
+- spec/resources/ascii.txt
+- spec/resources/binary.jpg
+- spec/spec_helper.rb
+homepage: https://github.com/rcaught/file_classify
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Binary and ASCII classification for files
+test_files:
+- spec/lib/file_classify_spec.rb
+- spec/resources/ascii.txt
+- spec/resources/binary.jpg
+- spec/spec_helper.rb