file_police 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    M2RiZjI0M2Q2MzM2N2UwZmMyYWRkZDQxM2U0Y2JhYWU1YWJjY2NkZg==
+  data.tar.gz: !binary |-
+    OTQ2NTA5ODAyNDI4NDA5ODI4N2NiOTk0MmQ4ZGIwYWMxNmNjODc4Mg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    OGMwNzBkZjIyODA4MWZiZTQxMTZjZmE4ODM4NWJiNWE2MjllZjExNGEwNTBi
+    MmJlMWJiZDIwNzZmYzExMjFiMTQ3MmE1NmQ5ZTFkMWU1YzQ3NTc1MzQwNWZi
+    MDgwYTIzZWI0MzVkYmI0MThkMzc3ZjRhNjU2MzVhNmVjY2Q1ZjM=
+  data.tar.gz: !binary |-
+    OGI3MzY2OTE3NzA0MzBjNzNkYWQ4NTkyNDY4YjQ3ZWE3MDc2OWFjN2ZhZGQ4
+    NzUzMWQ1Y2I4NWM2NTQyZGVlMGJlOWJlMmM3MWNlNmY4ZTU5MTcyYmU2OTVj
+    NjBjZjM3MmRjNzA3ZWMxNmQ0M2QxYTgwYmZmMWUxYWY2MDMzMTA=

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,27 @@
+PATH
+  remote: .
+  specs:
+    file_police (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.4)
+    rake (10.1.0)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  file_police!
+  rake
+  rspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Adam Wead
+
+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 @@
+# FilePolice
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'file_police'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install file_police
+
+## 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,11 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+# Rake task for getting an irb session
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -I lib -r file_police.rb"
+end
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/file_police.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'file_police/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "file_police"
+  spec.version       = FilePolice::VERSION
+  spec.authors       = ["Adam Wead"]
+  spec.email         = ["amsterdamos@gmail.com"]
+  spec.description   = "Policing our files"
+  spec.summary       = "Policing our files"
+  spec.homepage      = ""
+  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"
+end

data/lib/file_police/backlog_file.rb

@@ -0,0 +1,53 @@
+# Checks the name of a file in our backlog for proper format.
+#
+# Ex. 
+# >  good = BacklogFile.new(filepath)
+# >  good.errors
+# => []
+# >  bad = BacklogFile.new(filepath)
+# >  bad.errors
+# => ["This is bad", "That is bad"]
+#
+class FilePolice::BacklogFile
+
+  attr_accessor :collection, :box, :folder, :name, :number, :errors
+
+  def initialize path
+    parts = File.basename(path, File.extname(path)).split("_")
+    self.errors = Array.new
+    if parts.length == 5
+      validate_collection(parts[0])
+      validate_box(parts[1])
+      validate_folder(parts[2])
+      self.name = parts[3]
+      validate_number(parts[4])
+    else
+      self.errors << "Filename does not have 5 segments separated by underscores (_)"
+    end
+  end
+
+  # Should match strings like ARC0001
+  def validate_collection collection = String.new
+    self.errors << "#{collection} does not match ARC#### format" unless collection.match(/^ARC[0-9]{4,4}$/)
+    self.collection = collection
+  end
+
+  # Should match strings like BX1
+  def validate_box box = String.new
+    self.errors << "#{box} does not match BX# format" unless box.match(/^BX[0-9]{1,3}$/)
+    self.box = box
+  end
+
+  # Should match strings like FL1
+  def validate_folder folder = String.new
+    self.errors << "#{folder} does not match FL# format" unless folder.match(/^FL[0-9]{1,3}$/)
+    self.folder = folder
+  end
+
+  # Sould be numbers only
+  def validate_number number = String.new
+    self.errors << "#{number} does not match number format" unless number.match(/^[0-9]{1,4}$/)
+    self.number = number
+  end
+
+end

data/lib/file_police/ticket.rb

@@ -0,0 +1,10 @@
+class FilePolice::Ticket
+
+  attr_accessor :file, :violations
+
+  def initialize file, violations
+    self.file = file
+    self.violations = violations
+  end
+
+end

data/lib/file_police/version.rb

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

data/lib/file_police.rb

@@ -0,0 +1,20 @@
+require 'csv'
+
+module FilePolice
+
+  def self.version
+    FilePolice::VERSION
+  end
+
+  # Patrol a directory and return tickets for any violations
+  def self.patrol path, tickets = Array.new
+    Dir.glob(File.join(path, "**/*")).each do |file|
+      tickets << Ticket.new(File.basename(file), FilePolice::BacklogFile.new(file).errors) unless File.directory?(file)
+    end
+    return tickets
+  end
+
+end
+
+require 'file_police/backlog_file'
+require 'file_police/ticket'

data/spec/backlog_file_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+
+describe FilePolice::BacklogFile do
+  
+  describe "valid filenames" do
+
+    before :each do
+      @sample = FilePolice::BacklogFile.new("ARC0001_BX1_FL1_name_001.tif")
+    end
+
+    it "must have no errors" do
+      @sample.errors.should be_empty
+    end
+
+    it "must have a collection" do
+      @sample.collection.should == "ARC0001"
+    end
+
+    it "must have a box" do
+      @sample.box.should == "BX1"
+    end
+
+    it "must have a folder" do
+      @sample.folder.should == "FL1"
+    end
+
+    it "must have some kind of name" do
+      @sample.name.should == "name"
+    end
+
+    it "must have a number for the file" do
+      @sample.number.should == "001"
+    end
+
+  end
+
+  describe "an invalid filename" do
+
+    it "has too many parts" do
+      invalid = FilePolice::BacklogFile.new("ARC0001_BX1_FL4_name_extra_001.tif")
+      invalid.errors.should include "Filename does not have 5 segments separated by underscores (_)"
+    end
+
+    its "has not enough parts" do
+      invalid = FilePolice::BacklogFile.new("ARC0001_BX1_001.tif")
+      invalid.errors.should include "Filename does not have 5 segments separated by underscores (_)"
+    end
+
+    it "has an incorrect collection" do
+      ["ARC-001_x_x_x_x", "ARC1_x_x_x_x", "ARC 001_x_x_x_x" ].each do |file|
+        invalid = FilePolice::BacklogFile.new(file)
+        invalid.errors.should include "#{invalid.collection} does not match ARC#### format"
+      end
+    end
+
+    it "has an incorrect box" do
+      invalid = FilePolice::BacklogFile.new("ARC0001_box2_FL4_name_001.tif")
+      invalid.errors.should include "box2 does not match BX# format"
+    end
+
+    it "has an incorrect folder" do
+      invalid = FilePolice::BacklogFile.new("ARC0001_BX1_folder3_name_001.tif")
+      invalid.errors.should include "folder3 does not match FL# format"
+    end
+
+  end
+
+end 

data/spec/police_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe FilePolice do
+  
+  describe "::patrol" do
+    it "should return an array of tickets with violations" do
+      tickets = FilePolice.patrol("spec/fixtures/bad")
+      tickets.should be_kind_of Array
+      tickets.first.should be_kind_of FilePolice::Ticket
+      tickets.collect { |t| t.file unless t.violations.empty? }.should include "ARC0001_box11_FL1_name_001.tif"
+    end
+
+    it "should return an array of tickets without violations" do
+      tickets = FilePolice.patrol("spec/fixtures/good")
+      tickets.collect { |t| t.file unless t.violations.empty? }.compact.should be_empty
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'file_police'
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/ticket_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe FilePolice::Ticket do
+
+  before :each do
+    @ticket = FilePolice::Ticket.new("foo", ["issue1", "issue2"])
+  end
+
+  it "should have a file" do
+    @ticket.file.should == "foo"
+  end
+
+  it "should violations" do
+    @ticket.violations.should == ["issue1", "issue2"]
+  end
+
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: file_police
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Adam Wead
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-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'
+description: Policing our files
+email:
+- amsterdamos@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- file_police.gemspec
+- lib/file_police.rb
+- lib/file_police/backlog_file.rb
+- lib/file_police/ticket.rb
+- lib/file_police/version.rb
+- spec/backlog_file_spec.rb
+- spec/fixtures/bad/ARC 0001_BX1_FL1_name_001.tif
+- spec/fixtures/bad/ARC0001_BX1_FL1_001.tif
+- spec/fixtures/bad/ARC0001_BX1_FL1_name_001.tif
+- spec/fixtures/bad/ARC0001_box11_FL1_name_001.tif
+- spec/fixtures/good/ARC0136_BX1_FL2_FanLetters_0100.tif
+- spec/fixtures/good/ARC0136_BX1_FL2_FanLetters_0101.tif
+- spec/fixtures/good/ARC0136_BX1_FL2_FanLetters_0102.tif
+- spec/fixtures/good/ARC0136_BX1_FL2_FanLetters_0103.tif
+- spec/fixtures/good/ARC0136_BX1_FL2_FanLetters_0104.tif
+- spec/fixtures/good/ARC0136_BX1_FL2_FanLetters_0105.tif
+- spec/fixtures/good/ARC0136_BX1_FL2_FanLetters_0106.tif
+- spec/fixtures/good/nested/ARC0136_BX1_FL2_FanLetters_0106.tif
+- spec/police_spec.rb
+- spec/spec_helper.rb
+- spec/ticket_spec.rb
+homepage: ''
+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: Policing our files
+test_files:
+- spec/backlog_file_spec.rb
+- spec/fixtures/bad/ARC 0001_BX1_FL1_name_001.tif
+- spec/fixtures/bad/ARC0001_BX1_FL1_001.tif
+- spec/fixtures/bad/ARC0001_BX1_FL1_name_001.tif
+- spec/fixtures/bad/ARC0001_box11_FL1_name_001.tif
+- spec/fixtures/good/ARC0136_BX1_FL2_FanLetters_0100.tif
+- spec/fixtures/good/ARC0136_BX1_FL2_FanLetters_0101.tif
+- spec/fixtures/good/ARC0136_BX1_FL2_FanLetters_0102.tif
+- spec/fixtures/good/ARC0136_BX1_FL2_FanLetters_0103.tif
+- spec/fixtures/good/ARC0136_BX1_FL2_FanLetters_0104.tif
+- spec/fixtures/good/ARC0136_BX1_FL2_FanLetters_0105.tif
+- spec/fixtures/good/ARC0136_BX1_FL2_FanLetters_0106.tif
+- spec/fixtures/good/nested/ARC0136_BX1_FL2_FanLetters_0106.tif
+- spec/police_spec.rb
+- spec/spec_helper.rb
+- spec/ticket_spec.rb