dpn-bagit 0.3.0 → 0.3.1

data/.travis.yml

@@ -1,3 +1,12 @@
 language: ruby
+
 rvm:
-  - 2.2.1
+  - 2.2.5
+  - 2.3.1
+
+script: rake test
+
+
+addons:
+    code_climate:
+        repo_token: d20107af76061a5ccc8a26570c7eab36d3771f7e5d304ae4e6bc4a0aaa7a5cb4

data/Gemfile

@@ -2,3 +2,6 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in dpn-bagit.gemspec
 gemspec
+
+gem "codeclimate-test-reporter", group: :test, require: nil
+

data/README.md

@@ -1,3 +1,6 @@
+
+[![Build Status](https://travis-ci.org/dpn-admin/dpn-bagit.svg?branch=master)](https://travis-ci.org/dpn-admin/dpn-bagit) [![Code Climate](https://codeclimate.com/github/dpn-admin/dpn-bagit/badges/gpa.svg)](https://codeclimate.com/github/dpn-admin/dpn-bagit) [![Test Coverage](https://codeclimate.com/github/dpn-admin/dpn-bagit/badges/coverage.svg)](https://codeclimate.com/github/dpn-admin/dpn-bagit/coverage)
+
 # DPN::Bagit
 
 ## Description

data/bin/dpn-bagit-validator

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require "dpn/bagit"
+require "optparse"
+
+options = {}
+opt_parser = OptionParser.new do |opt|
+  opt.banner = "Usage: dpn-bagit-validator DIRECTORY"
+  opt.on "-l", "--location=PATH",
+         "Path to the volume's directory." do |location|
+    options[:location] = location
+  end
+  opt.on_tail("-h", "--help", "Show this message") do
+    puts opt
+    exit
+  end
+end
+
+opt_parser.parse!
+
+raise ArgumentError unless options[:location]
+
+
+
+bag = DPN::Bagit::Bag.new(options[:location])
+if bag.valid?
+  puts "Bag is valid."
+else
+  puts "Bag is invalid."
+  puts ""
+  puts bag.errors
+end

data/dpn-bagit.gemspec

@@ -21,6 +21,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.8"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "test-unit"
+  spec.add_development_dependency "yard", "~> 0.8"
+  spec.add_development_dependency "simplecov"
 
   spec.add_runtime_dependency "configliere"
   spec.add_runtime_dependency "bagit", "~>0.3.2"

data/lib/dpn/bagit/bag.rb

@@ -20,11 +20,8 @@ class DPN::Bagit::Bag
         @dpnObjectID = nil
 
         @dpnInfo = DPNInfoTxt.new(self.dpn_info_file_location())
-        if @dpnInfo[:dpnObjectID] == nil
-          @dpnObjectID = File.basename(_location)
-        else
-          @dpnObjectID = @dpnInfo[:dpnObjectID]
-        end
+        @dpnObjectID = @dpnInfo[:dpnObjectID]
+        @dpnObjectID ||= File.basename(_location)
     end
 
 

data/lib/dpn/bagit/bag/dpn_info_txt.rb

@@ -5,86 +5,123 @@ class DPN::Bagit::Bag
   # changes made to the underlying txt file; in that case, a new Bag should be created.
   # @private
   class DPNInfoTxt
-    private
-      def initialize(fileLocation)
-        @settings = DPN::Bagit::Settings.instance.config
-        @dpnInfoKeysArrays = @settings[:bag][:dpn_info][:arrays]
-        @dpnInfoKeysNonArrays = @settings[:bag][:dpn_info][:non_arrays]
-        @dpnInfoErrors = []
-        @dpnInfo = {}
-        self.validate!(fileLocation)
+
+    # @overload initialize(file_location)
+    #   Build a DPNInfoText from an existing dpn-info.txt file.
+    #   @param [String] file_location The location of the existing dpn-info.txt.
+    # @overload initialize(opts)
+    #   Build a DPNInfoText from scratch by supplying an options hash.
+    #   @param [Hash] opts
+    #   @option opts [String] :dpnObjectID
+    #   @option opts [String] :localName
+    #   @option opts [String] :ingestNodeName
+    #   @option opts [String] :ingestNodeAddress
+    #   @option opts [String] :ingestNodeContactName
+    #   @option opts [String] :ingestNodeContactEmail
+    #   @option opts [Fixnum] :version
+    #   @option opts [String] :firstVersionObjectID
+    #   @option opts [String] :bagTypeName
+    #   @option opts [Array<String>] :interpretiveObjectIDs
+    #   @option opts [Array<String>] :rightsObjectIDs
+    def initialize(opts)
+      @settings = DPN::Bagit::Settings.instance.config
+      @dpnInfoKeysArrays = @settings[:bag][:dpn_info][:arrays]
+      @dpnInfoKeysNonArrays = @settings[:bag][:dpn_info][:non_arrays]
+      @dpnInfoErrors = []
+      @dpnInfo = {}
+      if opts.is_a? String
+        self.from_existing(opts)
+      else
+        self.build(opts)
       end
+    end
+
+
+    # Check for validity
+    # @return [Boolean]
+    def valid?
+      return @dpnInfoErrors.empty?
+    end
+
+
+    # Returns a list of any errors encountered on creation and validation.
+    # @return [Array<String]
+    def getErrors()
+      return @dpnInfoErrors
+    end
+
+
+    # Get the value associated with the given field.
+    # @param key [Symbol]
+    def [](key)
+      return @dpnInfo[key.to_sym]
+    end
 
     protected
-      def validate!(fileLocation)
-        @dpnInfoKeysArrays.each do |key|
-          @dpnInfo[key.to_sym] = []
-        end
 
-        if File.exists?(fileLocation)
-          if File.readable?(fileLocation)
-            contents = nil
-            File.open(fileLocation, 'r') do |file|
-              contents = file.read
-            end
+    def build(opts)
+      (@dpnInfoKeysNonArrays + @dpnInfoKeysArrays).each do |key|
+        key = key.to_sym
+        @dpnInfo[key] = opts[key]
+      end
+    end
 
-            @dpnInfoKeysNonArrays.each do |key|
-              key = key.to_sym	#does nothing if settings correctly configured
-              pattern  = @settings[:bag][:dpn_info][key][:regex] + @settings[:bag][:dpn_info][:capture]
-              regex = Regexp.new(pattern)
-              match = regex.match(contents)
-              if match == nil or match[1] == nil
-                @dpnInfoErrors.push("dpn-info.txt does not have the tag #{@settings[:bag][:dpn_info][key][:name]}")
-              else
-                @dpnInfo[key] = match[1]
-              end
 
-              if @dpnInfo[key].respond_to?(:strip!)
-                @dpnInfo[key].strip!
-                @dpnInfo[key].downcase!
-              end
+    def from_existing(file_location)
+      @dpnInfoKeysArrays.each do |key|
+        @dpnInfo[key.to_sym] = []
+      end
+
+      if File.exists?(file_location)
+        if File.readable?(file_location)
+          contents = File.read(file_location)
 
+          @dpnInfoKeysNonArrays.each do |key|
+            key = key.to_sym	#does nothing if settings correctly configured
+            pattern  = @settings[:bag][:dpn_info][key][:regex] + @settings[:bag][:dpn_info][:capture]
+            regex = Regexp.new(pattern)
+            match = regex.match(contents)
+            if match == nil or match[1] == nil
+              @dpnInfoErrors.push("dpn-info.txt does not have the tag #{@settings[:bag][:dpn_info][key][:name]}")
+            else
+              @dpnInfo[key] = match[1]
             end
 
-            @dpnInfoKeysArrays.each do |key|
-              key = key.to_sym	#does nothing if settings correctly configured
-              pattern  = @settings[:bag][:dpn_info][key][:regex] + @settings[:bag][:dpn_info][:capture]
-              regex = Regexp.new(pattern)
-              if regex.match(contents) == nil
-                @dpnInfoErrors.push("dpn-info.txt does not have the tag #{@settings[:bag][:dpn_info][key][:name]}")
-                @dpnInfo[key] = []
-              else
-                @dpnInfo[key] = contents.scan(regex)
-                @dpnInfo[key].flatten!
-                @dpnInfo[key].each_index do |i|
-                  @dpnInfo[key][i].strip!
-                  @dpnInfo[key][i].downcase!
-                  if @dpnInfo[key][i] == ''
-                    @dpnInfo[key].delete_at(i)
-                  end
+            if @dpnInfo[key].respond_to?(:strip!)
+              @dpnInfo[key].strip!
+              @dpnInfo[key].downcase!
+            end
+
+          end
+
+          @dpnInfoKeysArrays.each do |key|
+            key = key.to_sym	#does nothing if settings correctly configured
+            pattern  = @settings[:bag][:dpn_info][key][:regex] + @settings[:bag][:dpn_info][:capture]
+            regex = Regexp.new(pattern)
+            if regex.match(contents) == nil
+              @dpnInfoErrors.push("dpn-info.txt does not have the tag #{@settings[:bag][:dpn_info][key][:name]}")
+              @dpnInfo[key] = []
+            else
+              @dpnInfo[key] = contents.scan(regex)
+              @dpnInfo[key].flatten!
+              @dpnInfo[key].each_index do |i|
+                @dpnInfo[key][i].strip!
+                @dpnInfo[key][i].downcase!
+                if @dpnInfo[key][i] == ''
+                  @dpnInfo[key].delete_at(i)
                 end
               end
             end
-          else
-            @dpnInfoErrors.push("dpn-info.txt exists, but cannot be opened for reading.")
           end
-
         else
-          @dpnInfoErrors.push("dpn-info.txt cannot be found.")
+          @dpnInfoErrors.push("dpn-info.txt exists, but cannot be opened for reading.")
         end
-      end
 
-    public
-      # Returns a list of any errors encountered on creation and validation.
-      # @return [Array<String]
-      def getErrors()
-        return @dpnInfoErrors
+      else
+        @dpnInfoErrors.push("dpn-info.txt cannot be found.")
       end
+    end
+
 
-      # Get the value associated with the given field.
-      # @param key [Symbol]
-      def [](key)
-        return @dpnInfo[key.to_sym]
-      end
   end
 end

data/lib/dpn/bagit/ext/bagit.rb

@@ -1,2 +1,3 @@
+require "bagit"
 require "dpn/bagit/ext/bagit/bag"
 require "dpn/bagit/ext/bagit/valid"

data/lib/dpn/bagit/settings.rb

@@ -1,9 +1,11 @@
+require "bundler/setup"
 require "configliere"
-require "bundler"
+require "singleton"
+
 
 # A class that manages the various settings required by dpn-bagit.
 class DPN::Bagit::Settings
-  include Singleton
+  include ::Singleton
 
   def initialize
     @config = nil

data/lib/dpn/bagit/version.rb

@@ -1,5 +1,5 @@
 module DPN
   module Bagit
-    VERSION = "0.3.0"
+    VERSION = "0.3.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dpn-bagit
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Bryan Hockey
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-05-22 00:00:00.000000000 Z
+date: 2016-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: configliere
   requirement: !ruby/object:Gem::Requirement
@@ -87,13 +115,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/dpn-bagit-validator
 - dpn-bagit.gemspec
 - lib/dpn/bagit.rb
 - lib/dpn/bagit/bag.rb
@@ -126,7 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: An implementation of the DPN Bagit spec.