sinderella 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1813bf663a9701a435caba5b1b3eab7769b247cc
+  data.tar.gz: d70679fededf9482ba94a5cc0e4a25629539c285
+SHA512:
+  metadata.gz: c987c2e6411c2e4085b5aac74d734ffdddd9702a74a2eec489defe338e091a540d8d928cdfb7649102c364f6c49de973d4f41dfa88143d70de44093caf6a16cd
+  data.tar.gz: ddece4bd51bd34cd6d319c32c33fb8bebb8acf856b8dd0e2735da2b673fe4a9e5cf672bd2a4b2243aaa61e05f32cee8b736e8819b0a773ffb437cfeb43b1f7e1

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+cache: bundler
+
+rvm:
+  - jruby
+
+script: 'bundle exec rake'
+
+notifications:
+  email:
+    recipients:
+      - mark.mcdx@gmail.com
+    on_failure: change
+    on_success: never
+

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,11 @@
+guard 'rspec' do
+  # watch /lib/ files
+  watch(%r{^lib/(.+)\.rb$}) do |m|
+    "spec/#{m[1]}_spec.rb"
+  end
+
+  # watch /spec/ files
+  watch(%r{^spec/(.+)\.rb$}) do |m|
+    "spec/#{m[1]}.rb"
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Integralist
+
+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,48 @@
+# Sinderella
+
+[![Build Status](https://travis-ci.org/Integralist/Sinderella.png?branch=master)](https://travis-ci.org/Integralist/Sinderella)
+
+Ruby gem which will allow authors to pass a code block to transform a data object for a specific period of time.
+
+Note I created this repo and all the code under the name "Cinderella" but it later transpired that the name was already taken and although the project owner has officially abandoned it I'm not able to take over the gem name...
+
+> nope, pick a new name. If anyone cares about it in 3 years I'll hand it over.
+
+So I decided to rename the project and publish the gem under the title of Sinderella instead.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sinderella'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sinderella
+
+## Usage
+
+```ruby
+data = { :key => 'value' }
+till_midnight = 60 * 60 # 1hr
+
+id = Sinderella.transforms(data, till_midnight) do |data|
+  data.each do |key, value|
+    data.tap { |d| d[key].upcase! } # convert data to uppercase
+  end
+end # returns a hash of the data to use as an id/key
+
+Sinderella.midnight(id) # reset the data ahead of schedule
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/Integralist/Sinderella/fork )
+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,10 @@
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+# Default directory to look within is `/specs`
+# Run with `rake spec`
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format', 'nested']
+end
+
+task :default => :spec

data/lib/sinderella.rb

@@ -0,0 +1,47 @@
+require 'sinderella/version'
+require 'sinderella/data_store'
+require 'crimp'
+
+module Sinderella
+  def self.transforms(data, till_midnight = 60)
+    identifier  = Crimp.signature(data)
+    cloned_data = deep_copy data
+    transformed = yield cloned_data
+
+    store({
+      :id => identifier,
+      :original => data,
+      :transformed => transformed
+    })
+
+    check(identifier, till_midnight)
+
+    identifier
+  end
+
+  def self.get(id)
+    DataStore.instance.get(id)[:transformed]
+  end
+
+  def self.midnight(id)
+    reset_data_at(id)
+  end
+
+  private
+
+  def self.store(data)
+    DataStore.instance.set(data)
+  end
+
+  def self.deep_copy(object)
+    Marshal.load(Marshal.dump(object))
+  end
+
+  def self.check(id, seconds)
+    Thread.new { sleep seconds; reset_data_at id }.join
+  end
+
+  def self.reset_data_at(id)
+    DataStore.instance.reset(id)
+  end
+end

data/lib/sinderella/data_store.rb

@@ -0,0 +1,34 @@
+require 'singleton'
+
+class DataStore
+  include Singleton
+
+  def set(data)
+    hash_data = {
+      :original    => data[:original],
+      :transformed => data[:transformed]
+    }
+
+    container.store(data[:id], hash_data)
+  end
+
+  def get(id)
+    container.fetch(id)
+  end
+
+  def reset(id)
+    original  = container.fetch(id)[:original]
+    hash_data = {
+      :original => original,
+      :transformed => original
+    }
+
+    container.store(id, hash_data)
+  end
+
+  private
+
+  def container
+    @store ||= Hash.new
+  end
+end

data/lib/sinderella/version.rb

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

data/sinderella.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sinderella/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sinderella"
+  spec.version       = Sinderella::VERSION
+  spec.authors       = ["Integralist"]
+  spec.email         = ["mark.mcdx@gmail.com"]
+  spec.summary       = 'Transform data for short period of time'
+  spec.description   = 'Allows authors to pass a code block to transform data object for a specific period of time'
+  spec.homepage      = 'https://github.com/Integralist/Cinderella'
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-nc"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-remote"
+  spec.add_development_dependency "pry-nav"
+
+  spec.add_runtime_dependency "crimp"
+end

data/spec/data_store_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe DataStore do
+  let(:instance)    { DataStore.instance }
+  let(:original)    { 'bar' }
+  let(:transformed) { 'BAR' }
+
+  before(:each) do
+    instance.set({
+      :id => 'foo',
+      :original => original,
+      :transformed => transformed
+    })
+  end
+
+  describe 'set(data)' do
+    it 'stores original and transformed data' do
+      expect(instance.get('foo')[:original]).to eq(original)
+      expect(instance.get('foo')[:transformed]).to eq(transformed)
+    end
+  end
+
+  describe 'get(id)' do
+    it 'returns data object' do
+      expect(instance.get('foo')).to be_a Hash
+      expect(instance.get('foo').key?(:original)).to be true
+      expect(instance.get('foo').key?(:transformed)).to be true
+    end
+  end
+
+  describe 'reset(id)' do
+    it 'replaces the transformed data with original data' do
+      instance.reset('foo')
+      foo = instance.get('foo')
+      expect(foo[:original]).to eq(foo[:transformed])
+    end
+  end
+end

data/spec/sinderella_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe Sinderella do
+  let(:data) {{ :key => 'value' }}
+  let(:till_midnight) { 0 }
+
+  def create_new_instance
+    @id = subject.transforms(data, till_midnight) do |data|
+      data.each do |key, value|
+        data.tap { |d| d[key].upcase! }
+      end
+    end
+  end
+
+  describe '.transforms(data, till_midnight)' do
+    it 'returns a md5 hash of the provided data' do
+      create_new_instance
+      expect(@id).to be_a String
+      expect(@id).to eq '24e73d3a4f027ff81ed4f32c8a9b8713'
+    end
+  end
+
+  describe '.get(id)' do
+    context 'before midnight (before time expired)' do
+      it 'returns the transformed data' do
+        Sinderella.stub(:check)
+        create_new_instance
+        expect(subject.get(@id)).to eq({ :key => 'VALUE' })
+      end
+    end
+
+    context 'past midnight (after time expired)' do
+      it 'returns the original data' do
+        create_new_instance
+        expect(subject.get(@id)).to eq({ :key => 'value' })
+      end
+    end
+  end
+
+  describe '.midnight(id)' do
+    context 'before midnight (before time expired)' do
+      it 'restores the data to its original state' do
+        Sinderella.stub(:check)
+        create_new_instance
+        subject.midnight(@id)
+        expect(subject.get(@id)).to eq({ :key => 'value' })
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'pry'
+require 'sinderella'

metadata

@@ -0,0 +1,201 @@
+--- !ruby/object:Gem::Specification
+name: sinderella
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Integralist
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2014-02-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rake
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rspec
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rspec-nc
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: guard
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: pry
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: pry-remote
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: crimp
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :runtime
+description: Allows authors to pass a code block to transform data object for a specific period of time
+email:
+- mark.mcdx@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sinderella.rb
+- lib/sinderella/data_store.rb
+- lib/sinderella/version.rb
+- sinderella.gemspec
+- spec/data_store_spec.rb
+- spec/sinderella_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/Integralist/Cinderella
+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.1.9
+signing_key:
+specification_version: 4
+summary: Transform data for short period of time
+test_files:
+- spec/data_store_spec.rb
+- spec/sinderella_spec.rb
+- spec/spec_helper.rb