kelredd-repository 0.2.0

data/README.rdoc

@@ -0,0 +1,53 @@
+= Repository
+
+== Description
+
+Abstracts a file storage system. 
+
+=== FileSystem
+Including FileSystem class will mix in methods for accessing a file
+system.   All path designations are made with arrays, referenced from
+a common root, where each array element corresponds to a path segment.
+The class handles joining the segments with the appropriate seperator
+for the file system being used.  You should override the ROOT constant
+appropriately, depending on where you want your repository to live.
+Check out the code for more detail.
+
+== Installation
+
+    sudo gem install kelredd-repository --source http://gems.github.com
+
+== Usage
+
+    require 'rubygems'
+    require 'repository/file_system'
+    Repository::FileSystem::ROOT = "/some/path/to/a/repo"
+    
+    
+    (mixes in all kinds of helper methods for dealing with files and paths at above root)
+    include FileSystem
+
+== License
+
+Copyright (c) <year> <copyright holders>
+
+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/Rakefile

@@ -0,0 +1,40 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rake/testtask'
+
+require 'lib/repository/version'
+
+task :default => :test
+
+spec = Gem::Specification.new do |s|
+  s.name             = 'repository'
+  s.version          = Repository::Version.to_s
+  s.has_rdoc         = true
+  s.extra_rdoc_files = %w(README.rdoc)
+  s.rdoc_options     = %w(--main README.rdoc)
+  s.summary          = "Abstracts a file storage system."
+  s.author           = 'Kelredd'
+  s.email            = ''
+  s.homepage         = ''
+  s.files            = %w(README.rdoc Rakefile) + Dir.glob("{lib,test}/**/*")
+  # s.executables    = ['repository']
+  
+  # s.add_dependency('gem_name', '~> 0.0.1')
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end
+
+desc 'Generate the gemspec to serve this Gem from Github'
+task :github do
+  file = File.dirname(__FILE__) + "/#{spec.name}.gemspec"
+  File.open(file, 'w') {|f| f << spec.to_ruby }
+  puts "Created gemspec: #{file}"
+end

data/lib/repository/file_system/base.rb

@@ -0,0 +1,86 @@
+module Repository
+  class FileSystem
+
+    # all path designations should be passed as arrays, where each array element corresponds to a path segment
+    # the class handles joining the segments with the appropriate seperator
+  
+    # you should override ROOT appropriately, depending on where you want your repo located
+    ROOT ||= '/'
+    WRITE = "w"
+    READ = "r"
+    
+    # Return the array of the repository root
+    def self.root_array
+      ROOT.split(File::SEPARATOR)
+    end
+    
+    # Return the full file system path of the given directory or file
+    def self.sys_path_array(rep_path = [])
+      self.root_array+rep_path
+    end
+    
+    # Return the full file system path of the given directory or file
+    def self.sys_path(rep_path = [])
+      sys_path_array(rep_path).join(File::SEPARATOR)
+    end
+    
+    # Read the file data specified by the given path
+    def self.read(rep_path)
+      File.open(self.sys_path(rep_path), READ) { |file| yield file.read }
+    end
+    
+    # Delete a file at the given path in the repository
+    def self.delete(rep_path)
+      File.delete(self.sys_path(rep_path)) if self.exists?(rep_path)
+    end
+    
+    # Change the permission of a file
+    def self.chmod(rep_path, permission)
+      File.chmod(permission, self.sys_path(rep_path))
+    end
+    
+    # Return whether a path exists or not
+    def self.exists?(rep_path)
+     File.exists?(self.sys_path(rep_path))
+    end
+    
+    # Writes file data to the given path
+    def self.write(data, file_rep_path)
+      File.open(self.sys_path(file_rep_path), WRITE) { |file| file.write(data) }      
+    end
+  
+    # Create the specified directory and any parent dirs in the root
+    def self.mkdir(rep_dir, permission=0777)
+      FileUtils.makedirs(self.sys_path(rep_dir))
+      FileUtils.chmod(permission, self.sys_path(rep_dir))
+      rep_dir
+    end
+    
+    # Copy the file from param1 to location specified in param2
+    def self.cp(from_rep_path, to_rep_path)
+      FileUtils.cp(self.sys_path(from_rep_path), self.sys_path(to_rep_path))
+    end
+    
+    # Same as cp except recrusive
+    def self.cpdir(from_rep_path, to_rep_path)
+      FileUtils.cp_r(self.sys_path(from_rep_path), self.sys_path(to_rep_path))
+    end
+    
+    # Delete the specified directory and contents in the root
+    def self.rmdir(rep_dir)
+      sys_path = self.sys_path(rep_dir)
+      if File.exists?(sys_path)
+        Dir.foreach(sys_path) {|file_name| File.delete(self.sys_path(rep_dir+[file_name])) if !File.directory?(self.sys_path(rep_dir+[file_name])) }
+        Dir.delete(sys_path)
+      end
+      rep_dir
+    end
+
+    # Return the filtered contents of a directory in an array
+    def self.directory_contents(rep_path, filter = '*')
+      Dir[self.sys_path(rep_path+[filter])]
+    end
+    
+  end
+   
+end

data/lib/repository/file_system/helpers.rb

@@ -0,0 +1,24 @@
+module Repository
+  class FileSystem
+    module Helpers
+      FILE_SIZE_ABBREVS = ['Bytes', 'KB', 'MB', 'GB']
+
+      def abbrev_file_size(size_in_bytes)
+        value = size_in_bytes
+        FILE_SIZE_ABBREVS.each do |abbrev|
+          return value.to_s + ' ' + abbrev if value < 1000 || abbrev == FILE_SIZE_ABBREVS.last
+          value /= 1000
+        end
+      end
+
+      def full_file_name=(full_name)
+        self.extension = File.extname(full_name).downcase.chomp if new_record?
+        self.file_name = clean_file_name(full_name)
+      end
+
+      def clean_file_name(file_name)
+        File.basename(file_name,'.*').gsub(/\s+/,'_').gsub(/_+/,'_').gsub(/[^\w._-]/,'').chomp
+      end
+    end
+  end
+end

data/lib/repository/file_system.rb

@@ -0,0 +1,2 @@
+$:.unshift File.dirname(__FILE__)
+require 'file_system/base'

data/lib/repository/version.rb

@@ -0,0 +1,13 @@
+module Repository
+  module Version
+    
+    MAJOR = 0
+    MINOR = 2
+    TINY  = 0
+    
+    def self.to_s # :nodoc:
+      [MAJOR, MINOR, TINY].join('.')
+    end
+    
+  end
+end

data/lib/repository.rb

@@ -0,0 +1,2 @@
+$:.unshift File.dirname(__FILE__)
+p "Don't require in this file, require in the type of repository class you want to use, ie require 'repository/file_system'"

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+# http://sneaq.net/textmate-wtf
+$:.reject! { |e| e.include? 'TextMate' }
+
+require 'rubygems'
+require 'test/unit'
+require 'matchy'
+require 'context'
+require 'mocha'
+
+require File.dirname(__FILE__) + '/../lib/repository'

data/test/unit/repository_test.rb

@@ -0,0 +1,13 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class RepositoryTest < Test::Unit::TestCase
+
+  describe "An instance of the Repository class" do
+
+    it "should flunk" do
+      flunk "Please provide some tests"
+    end
+    
+  end
+
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+name: kelredd-repository
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Kelredd
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-22 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: ""
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- Rakefile
+- lib/repository
+- lib/repository/file_system
+- lib/repository/file_system/base.rb
+- lib/repository/file_system/helpers.rb
+- lib/repository/file_system.rb
+- lib/repository/version.rb
+- lib/repository.rb
+- test/test_helper.rb
+- test/unit
+- test/unit/repository_test.rb
+has_rdoc: true
+homepage: ""
+post_install_message: 
+rdoc_options: 
+- --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: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Abstracts a file storage system.
+test_files: []
+