tsalzer-richfile 0.0.2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Till Salzer
+
+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,49 @@
+= Richfile
+
+A simple gem which adds some additional methods to File objects.
+
+== Install
+
+  gem install tsalzer-richfile --source http://gems.github.com
+
+
+== What is a Richfile?
+
+Richfile extends the Ruby built-in File instances with some somtimes
+useful attributes.
+
+Note that there is no built-in magic to keep the once-fetched attributes
+in sync with the effective attributes of the real files.
+
+== Usage
+
+You simple require richfile:
+
+  require 'richfile'
+
+Now, every new File object has a list of additional attributes. Whenever you
+access the attributes the first time, the data is pulled from the file system
+and cached in the File object.
+
+If you need to refresh the data, either call +refresh!+, which updates every
+attribute you used before, or +refresh_all!+, which updates each of the cached
+attributes. When you are just interested in a single attribute, call the
+attribute with an added bang (like +size!+).
+
+== Building a new Gem
+
+To create a new gem, you need to install the echoe gem (see
+http://blog.evanweaver.com/files/doc/fauna/echoe/files/README.html).
+Next, edit the Rakefile to reflect your changes, then run:
+
+  rake clobber        # remove generated stuff for a clean manifest
+  rake manifest       # only needed if you changed the file set
+  rake build_gemspec  # update the gemspec
+
+Now, you can either publish the gem, or build a gem package. See rake -T for
+available targets.
+
+== License
+
+The richfile gem comes to you under the MIT License. You should find the
+license text in the file MIT-LICENSE in the gem folder.

data/Rakefile

@@ -0,0 +1,17 @@
+# Rakefile for img_gravatar
+require 'rubygems'
+require 'rake'
+task :default => [:specs]
+require 'echoe'
+
+Echoe.new('richfile', '0.0.2') do |p|
+  p.description = "Extends File objects with some rich instance attributes."
+  p.url = "http://github.com/tsalzer/richfile"
+  p.author = "Till Salzer"
+  p.email = "till.salzer@googlemail.com"
+  p.ignore_pattern = ["tmp/*", "script/*", "rdoc/*", "pkg/*", "coverage/*", "*.tmproj"]
+  p.development_dependencies = ['rspec','rcov']
+  p.rdoc_pattern = /^(lib|bin|tasks|ext)|^README.rdoc|^CHANGELOG|^TODO|^MIT-LICENSE|^COPYING$/
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/init.rb

@@ -0,0 +1,3 @@
+# Include hook code here
+
+require 'richfile'

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/richfile/base.rb

@@ -0,0 +1,93 @@
+require 'openssl'
+
+# Extension to File.
+module Richfile
+  if OpenSSL::OPENSSL_VERSION_NUMBER > 0x00908000
+    DIGESTS = %w(DSS1 MD2 MD4 MD5 RIPEMD160 SHA SHA1 SHA224 SHA256 SHA384 SHA512)
+  else
+    DIGESTS = %w(DSS1 MD2 MD4 MD5 RIPEMD160 SHA SHA1)
+  end
+  
+  def self.digest_variants(digest)
+    digest_downcase = digest.downcase
+    digest_symbol = digest_downcase.to_sym
+    digest_bang = "#{digest_downcase}!".to_sym
+    digest_variable = "@#{digest_downcase}".to_sym
+    return digest_downcase, digest_symbol, digest_bang, digest_variable
+  end
+
+# Methods to be included in File objects.  
+module Base
+  # size of the file in bytes.
+  attr_reader :size
+  
+  # define attributes for all the digests in Richfile::DIGEST.
+  Richfile::DIGESTS.each do |digest|
+    d_downcase, d_sym, d_bang, d_var = Richfile.digest_variants(digest)
+    
+    # message digest #{digest}
+    attr_reader d_sym
+    
+    define_method d_sym do
+      instance_variable_set(d_var, File.open(path, 'r') do |f|
+        d = OpenSSL::Digest.new(digest)
+        d << f.read
+        d.hexdigest
+      end) unless instance_variable_get(d_var)
+      instance_variable_get(d_var)
+    end
+    define_method d_bang do
+      instance_variable_set(d_var, nil)
+      send d_sym
+    end
+  end
+  
+  # refresh the Richfile added attributes.
+  # All the attributes referred once are loaded.
+  def refresh!
+    self.size! if @size
+    DIGESTS.each do |digest|
+      d_downcase, d_sym, d_bang, d_var = Richfile.digest_variants(digest)
+      send d_bang if (instance_variable_get(d_var))
+    end
+    self
+  end
+  
+  # refresh all attributes.
+  # All attributes wil be loaded, so all digests will be calculated.
+  # You will most probably never need this method.
+  def refresh_all!
+    self.size!
+    DIGESTS.each do |digest|
+      d_downcase, d_sym, d_bang, d_var = Richfile.digest_variants(digest)
+      send d_bang
+    end
+    self
+  end
+  
+  # proxies File.exists?.
+  # This will always go to the real File.exists?, it will not be cached.
+  def exists?
+    File.exists?(path)
+  end
+  
+  # size of the file in bytes.
+  # see File#size
+  def size
+    @size = File.size(self.path) unless @size
+    @size
+  end
+  # refresh the size attribute.
+  def size!
+    @size = nil
+    self.size
+  end
+
+end#Base
+
+# include the Richfile::Base module into the File class.
+def self.install
+  File.send :include, Richfile::Base
+end
+
+end#Richfile

data/lib/richfile.rb

@@ -0,0 +1,2 @@
+require "#{File.dirname(__FILE__)}/richfile/base"
+Richfile.install

data/richfile.gemspec

@@ -0,0 +1,37 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{richfile}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Till Salzer"]
+  s.date = %q{2009-03-25}
+  s.description = %q{Extends File objects with some rich instance attributes.}
+  s.email = %q{till.salzer@googlemail.com}
+  s.extra_rdoc_files = ["lib/richfile/base.rb", "lib/richfile.rb", "MIT-LICENSE", "README.rdoc", "tasks/richfile_tasks.rake"]
+  s.files = ["init.rb", "install.rb", "lib/richfile/base.rb", "lib/richfile.rb", "MIT-LICENSE", "Rakefile", "README.rdoc", "specs/richfile_spec.rb", "specs/SimpleDigestTest.txt", "tasks/richfile_tasks.rake", "uninstall.rb", "Manifest", "richfile.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/tsalzer/richfile}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Richfile", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{richfile}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Extends File objects with some rich instance attributes.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end

data/specs/SimpleDigestTest.txt

@@ -0,0 +1,4 @@
+This file is used to test the Message Digest methods.
+However, this file hardly poses a challenge to any
+half-mature digest implementation. It is merely here
+to have a reference point for File.md5 and File.sha1.

data/specs/richfile_spec.rb

@@ -0,0 +1,142 @@
+require 'lib/richfile'
+require "md5"
+
+describe OpenSSL, "version" do
+  subject { OpenSSL::OPENSSL_VERSION_NUMBER }
+  it "should be greater than 0x00908000" do
+    subject.should be > 0x00908000
+  end
+end
+
+describe Richfile::Base, "example SimpleDigestTest.txt" do
+  subject { File.new(File.join(File.dirname(__FILE__), "SimpleDigestTest.txt")) }
+  
+  it "should exist" do
+    subject.exists?.should == true
+  end
+  
+  it "should have a size attribute" do
+    subject.should respond_to(:size)
+    subject.size.should be > 0
+    subject.size.should == File.size(subject)
+  end
+  it "should have a mtime attribute" do
+    subject.should respond_to(:mtime)
+    subject.mtime.should == File.mtime(subject)
+  end
+  it "should have a ctime attribute" do
+    subject.should respond_to(:ctime)
+    subject.ctime.should == File.ctime(subject)
+  end
+  
+  it "should yield the same result as the built-in MD5 function" do
+    d = MD5.new
+    File.open(File.join(File.dirname(__FILE__), "SimpleDigestTest.txt")) do |f|
+      d << f.read
+    end
+    d.hexdigest.should == subject.md5!
+  end
+end
+
+{ #:dss => nil, - unsupported
+  :dss1 => "dee5ba176cb2d1cc7d9a5fc3a2240a37645d6b46",
+  :md2 => "8c13cca992d071c02fd338b6c13ab71b",
+  :md4 => "3575477e0da66828dcbba890b728d855",
+  :md5 => "927f712a74d0cf1281f93874499986c2",
+  #:mdc2 => nil, - unsupported
+  :ripemd160 => "e9b5c5c6e110022f0a5b493ed1b267c6face4c17",
+  :sha => "26f42cf9c6cfe3d95ab924d3b89b210a526a1ea1",
+  :sha1 => "dee5ba176cb2d1cc7d9a5fc3a2240a37645d6b46", 
+  :sha224 => "e69ec20e01d6fac380b727b872dc0e14d1f255d40c3614e075d87de5",
+  :sha256 => "204e57f6dc0d8787f87e04347666129a2bd7deddf8949c735a78380b7c2ac65d",
+  :sha384 => "a2544e5c3b1a04b38ff0cf8cc29b81bd0fc08d12975949210123e51ae3af1da1538bf3fa6e1b73fc198bc0ac289f891f",
+  :sha512 => "137a67bfe730049222f7ac4969d14c3c79ee82d90bd1e223a0217abd8a73f617036222dce542d6243a7b94bc76ff1ee1359f073bb6a116df07c76c2164927800"
+  }.each do |cypher, checksum|
+  describe Richfile, ".#{cypher} message digest/checksum" do
+    subject { File.new(File.join(File.dirname(__FILE__), "SimpleDigestTest.txt")) }
+    it "should provide a #{cypher} attribute" do
+      subject.should respond_to(cypher)
+      subject.send(cypher).should == checksum
+    end
+    it "should provide a #{cypher}! method" do
+      subject.should respond_to("#{cypher}!".to_sym)
+      subject.send("#{cypher}!".to_sym).should == checksum
+    end
+  end
+end
+
+
+describe Richfile::Base do
+  subject { Richfile }
+  it "should have a DIGESTS constant with all digests" do
+    Richfile::DIGESTS.should == %w(DSS1 MD2 MD4 MD5 RIPEMD160 SHA SHA1 SHA224 SHA256 SHA384 SHA512)
+  end
+end
+
+describe Richfile::Base, "refresh!" do
+  subject { File.new(File.join(File.dirname(__FILE__), "SimpleDigestTest.txt")) }
+  
+  it "should refresh the file size if the size was used" do
+    subject.size
+    subject.should_receive(:size!).once
+    subject.refresh!
+  end
+  it "should not refresh the file size if the size was not used" do
+    subject.should_not_receive(:size!)
+    subject.refresh!
+  end
+
+  it "should refresh the MD5 digest if the MD5 digest was used" do
+    subject.md5
+    subject.should_receive(:md5!).once
+    subject.refresh!
+  end
+  it "should not refresh the MD5 digest if the MD5 digest was not used" do
+    subject.should_not_receive(:md5!)
+    subject.refresh!
+  end
+
+  it "should refresh the SHA1 digest if the SHA1 digest was used" do
+    subject.sha1
+    subject.should_receive(:sha1!).once
+    subject.refresh!
+  end
+  it "should not refresh the SHA1 digest if the SHA1 digest was not used" do
+    subject.should_not_receive(:sha1!)
+    subject.refresh!
+  end
+
+  it "should refresh the SHA512 digest if the SHA512 digest was used" do
+    subject.sha512
+    subject.should_receive(:sha512!).once
+    subject.refresh!
+  end
+  it "should not refresh the SHA512 digest if the SHA512 digest was not used" do
+    subject.should_not_receive(:sha512!)
+    subject.refresh!
+  end
+end
+
+describe Richfile::Base, "refresh_all!" do
+  subject { File.new(File.join(File.dirname(__FILE__), "SimpleDigestTest.txt")) }
+  
+  it "should refresh the file size" do
+    subject.should_receive(:size!).once
+    subject.refresh_all!
+  end
+
+  it "should refresh the MD5 digest" do
+    subject.should_receive(:md5!).once
+    subject.refresh_all!
+  end
+
+  it "should refresh the SHA1 digest" do
+    subject.should_receive(:sha1!).once
+    subject.refresh_all!
+  end
+
+  it "should refresh the SHA512 digest" do
+    subject.should_receive(:sha512!).once
+    subject.refresh_all!
+  end
+end

data/tasks/richfile_tasks.rake

@@ -0,0 +1,34 @@
+require 'rake'
+require 'spec/rake/spectask'
+
+ALWAYS_EXCLUDES=['specs/command_spec.rb']
+EXCLUDES=['specsserver_spec.rb'].concat(ALWAYS_EXCLUDES)
+
+def filelist(*opts)
+  exclude = []
+  o = *opts
+  if o
+    exclude = o[:exclude] if o[:exclude]
+  end
+  files = FileList['specs/**/*_spec.rb']
+  exclude.each do |f|
+    files.delete(f)
+  end
+  files
+end
+
+desc "Run all the specs"
+Spec::Rake::SpecTask.new('specs') do |t|
+  t.pattern = nil
+  t.spec_files = filelist(:exclude => EXCLUDES)
+  t.rcov = false
+end
+
+desc "Run all specs with RCov"
+Spec::Rake::SpecTask.new('rcov') do |t|
+  t.spec_files = filelist(:exclude => EXCLUDES)
+  t.rcov = true
+  t.rcov_opts = ['--exclude', 'specs/.*,buildlib/project\.rb,buildlib/buildlib\.rb,buildlib/command\.rb']
+end
+
+task :default => [:specs]

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification 
+name: tsalzer-richfile
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Till Salzer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-25 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Extends File objects with some rich instance attributes.
+email: till.salzer@googlemail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- lib/richfile/base.rb
+- lib/richfile.rb
+- MIT-LICENSE
+- README.rdoc
+- tasks/richfile_tasks.rake
+files: 
+- init.rb
+- install.rb
+- lib/richfile/base.rb
+- lib/richfile.rb
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+- specs/richfile_spec.rb
+- specs/SimpleDigestTest.txt
+- tasks/richfile_tasks.rake
+- uninstall.rb
+- Manifest
+- richfile.gemspec
+has_rdoc: true
+homepage: http://github.com/tsalzer/richfile
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Richfile
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: richfile
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Extends File objects with some rich instance attributes.
+test_files: []
+