status_cacher 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+.idea
+coverage
+pkg
+*.swp

data/.rvmrc

@@ -0,0 +1,46 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.9.3" > .rvmrc
+environment_id="ruby-1.9.3-p362@status_cacher"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.20.13 (stable)" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  for __hook in "${rvm_path:-$HOME/.rvm}/hooks/after_use"*
+  do
+    if [[ -f "${__hook}" && -x "${__hook}" && -s "${__hook}" ]]
+    then \. "${__hook}" || true
+    fi
+  done
+  unset __hook
+  if (( ${rvm_use_flag:=1} >= 2 )) # display only when forced
+  then
+    if [[ $- == *i* ]] # check for interactive shells
+    then printf "%b" "Using: \E[32m$GEM_HOME\E[0m" # show the user the ruby and gemset they are using in green
+    else printf "%b" "Using: $GEM_HOME" # don't use colors in non-interactive shells
+    fi
+  fi
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,24 @@
+PATH
+  remote: .
+  specs:
+    status_cacher (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.4)
+    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
+  rspec
+  status_cacher!

data/README.md

@@ -0,0 +1,31 @@
+# StatusCacher
+
+This gem provides a simple script that writes a status to a file. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+<code>gem 'status\_cacher'</code>
+
+And then execute:
+
+<code>bundle</code>
+
+Or install it yourself as:
+
+<code>gem install status\_cacher </code>
+
+## Usage
+
+require "status_cacher"
+
+### Writing Status
+<pre><code>status_cacher = StatusCacher.new("/tmp/filename")
+status_cacher.status = ("ok")
+</code></pre>
+
+### Reading Status
+<pre><code>status_cacher = StatusCacher.new("/tmp/filename")
+status_value = status_cacher.status
+</code></pre>

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/status_cacher.rb

@@ -0,0 +1,25 @@
+class StatusCacher
+  attr_accessor :status_path
+
+  def initialize(status_path)
+    raise ArgumentError("No status path specified") if status_path.nil?
+    @status_path = status_path
+
+    FileUtils.touch(status_path)
+  end
+
+  def status=(value)
+    File.open(@status_path, 'w') { |f|
+      f.write value
+    }
+  rescue StandardError => e
+    raise StatusStorageError.new("Could not write to status cache at #{@status_path}: #{e.inspect}")
+  end
+
+  def status
+    f = File.open(@status_path, "r")
+    f.read
+  rescue StandardError => e
+    raise StatusStorageError.new("Status path does not exist when it should #{@status_path}: #{e.inspect}")
+  end
+end

data/lib/status_storage_error.rb

@@ -0,0 +1,2 @@
+class StatusStorageError < IOError
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'bundler/setup'
+
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib' ))
+
+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
+end

data/spec/status_cacher_spec.rb

@@ -0,0 +1,90 @@
+require "spec_helper"
+
+require 'tempfile'
+require 'fileutils'
+
+require "status_cacher"
+require "status_storage_error"
+
+describe StatusCacher do
+  before :each do
+    @test_text = "test text"
+    @status_file_path = Tempfile.new("status-cacher-temp-").path
+  end
+
+  context "when initialized" do
+    it "should raise an argument error if no status file location is specified" do
+      expect {
+        @iut = StatusCacher.new
+      }.to raise_error ArgumentError
+    end
+
+    it "should remember the status file location specified" do
+      @iut = StatusCacher.new(@status_file_path)
+      @iut.status_path.should == @status_file_path
+    end
+  end
+
+  context "when asked to store a status" do
+    it "should create the status file if not present" do
+      FileUtils.rm_f(@status_file_path)
+      File.exists?(@status_file_path).should == false
+      @iut = StatusCacher.new(@status_file_path)
+      File.exists?(@status_file_path).should == true
+    end
+
+    it "should not overwrite the status file if present" do
+      populate_test_data
+      @iut = StatusCacher.new(@status_file_path)
+      File.read(@status_file_path).should == @test_text
+    end
+
+    it "should store only the value provided in the status file" do
+      populate_test_data
+      test_text = "new value"
+      @iut = StatusCacher.new(@status_file_path)
+      @iut.status = (test_text)
+      File.read(@status_file_path).should == test_text
+    end
+
+    it "should raise a StorageError if the store operation fails" do
+      mock_file = double(File)
+      File.should_receive(:open).and_yield(mock_file)
+      mock_file.should_receive(:write).and_raise RuntimeError
+      @iut = StatusCacher.new(@status_file_path)
+      expect{
+        @iut.status = "blah"
+      }.to raise_error StatusStorageError
+    end
+  end
+
+  context "when asked to return the current status" do
+    it "should return "" if the status file was not present" do
+      FileUtils.rm_f(@status_file_path)
+      @iut = StatusCacher.new(@status_file_path)
+      value = @iut.status
+      value.should == ""
+    end
+
+    it "should return the value stored in the status file" do
+      populate_test_data
+      @iut = StatusCacher.new(@status_file_path)
+      value = @iut.status
+      value.should == @test_text
+    end
+
+    it "should raise a StorageError if the file exists but could not be accessed" do
+      @iut = StatusCacher.new(@status_file_path)
+      expect{
+        @iut.status_path = "/djksghsfdksfgdklsjhfjks/"
+        @iut.status
+      }.to raise_error StatusStorageError
+    end
+  end
+
+  def populate_test_data
+    open(@status_file_path, 'a') { |f|
+      f.write @test_text
+    }
+  end
+end

data/status_cacher.gemspec

@@ -0,0 +1,14 @@
+Gem::Specification.new do |s|
+  s.name	  = 'status_cacher'
+  s.version	  = '0.0.1'
+  s.date	  = '2013-06-25'
+  s.summary	  = "Writes a status to a file"
+  s.description	  = ""
+  s.authors	  = ["Tiaan van Deventer"]
+  s.email	  = 'tiaan.van.deventer@gmail.com'
+  s.homepage	  = 'http://rubygems.org/gems/status_cacher'
+  s.files	  = `git ls-files`.split($\)
+  s.require_paths = ["lib/"]
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.add_development_dependency 'rspec'
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: status_cacher
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Tiaan van Deventer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email: tiaan.van.deventer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/status_cacher.rb
+- lib/status_storage_error.rb
+- spec/spec_helper.rb
+- spec/status_cacher_spec.rb
+- status_cacher.gemspec
+homepage: http://rubygems.org/gems/status_cacher
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib/
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Writes a status to a file
+test_files:
+- spec/spec_helper.rb
+- spec/status_cacher_spec.rb