scam 0.2.0

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,24 @@
+PATH
+  remote: .
+  specs:
+    scam (0.1.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec (~> 2.3)
+  scam!

data/README.rdoc

@@ -0,0 +1,56 @@
+= Scam
+
+Really basic model-ish thing for creating different types in your application easily.
+
+I use this whenever I want something to do psuedo belongs to/has many relationships, but do not want to back a model with a database as the data does not change often, if ever.
+
+== Usage
+
+Just create a class and include scam.
+
+    class FeedTemplate
+      include Scam
+
+      attr_accessor :title, :icon, :instructions, :template, :format, :label
+
+      def expand(value)
+        url = template.gsub('{value}', URI.escape(value))
+        url = "http://#{url}" if url !~ /https?\:\/\//
+        url
+      end
+
+      def parse(body)
+        case format
+          when 'json'
+            ActiveSupport::JSON.decode(body)
+          when 'feed'
+            Feedzirra::Feed.parse(body).to_hash
+        end
+      end
+    end
+
+    FeedTemplate.create({
+      :id           => 1,
+      :title        => 'Twitter',
+      :label        => 'Twitter Username',
+      :icon         => 'twitter',
+      :instructions => 'Enter your Twitter username',
+      :format       => 'json',
+      :template     => 'http://twitter.com/statuses/user_timeline/{value}.json',
+    })
+
+Attributes are just defined using attr_accessor. :id is added when you include Scam.
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 John Nunemaker. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+task :default => :spec

data/examples/simple.rb

@@ -0,0 +1,28 @@
+$LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+require 'pp'
+require 'scam'
+
+class FeedTemplate
+  include Scam
+
+  attr_accessor :title
+end
+
+FeedTemplate.create(:id => 1, :title => 'Twitter')
+FeedTemplate.create(:id => 2, :title => 'Dribble')
+
+pp FeedTemplate.all
+
+# Enumerable is on the class so you can just iterate it
+FeedTemplate.each do |tpl|
+  pp tpl
+end
+
+# detect, select, include, etc
+pp FeedTemplate.detect { |tpl| tpl.title == 'Twitter' }
+
+# find by id
+pp FeedTemplate.find(2)
+
+# works with string id
+pp FeedTemplate.find('2')

data/examples/sorted.rb

@@ -0,0 +1,17 @@
+$LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+require 'pp'
+require 'scam'
+
+class FeedTemplate
+  include Scam
+
+  sorted_by :title
+
+  attr_accessor :title
+end
+
+FeedTemplate.create(:id => 1, :title => 'Twitter')
+FeedTemplate.create(:id => 2, :title => 'Dribble')
+
+# Sorted by title instead of id so dribble will be first and twitter second
+pp FeedTemplate.all

data/lib/scam.rb

@@ -0,0 +1,52 @@
+module Scam
+  def self.included(base)
+    base.class_eval do
+      class << self
+        include Enumerable
+      end
+      attr_accessor :id
+    end
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    def all
+      instances.sort_by { |i| i.send(sorted_by) }
+    end
+
+    def sorted_by(attribute=nil)
+      @sorted_by = attribute unless attribute.nil?
+      @sorted_by = :id if @sorted_by.nil?
+      @sorted_by
+    end
+
+    def create(attrs={})
+      new(attrs).tap { |i| instances << i }
+    end
+
+    def each
+      instances.each { |i| yield(i) }
+    end
+
+    def find(id)
+      detect { |i| i.id == id.to_i }
+    end
+
+    alias [] find
+
+    def instances
+      @instances ||= []
+    end
+    private :instances
+  end
+
+  def initialize(attrs={})
+    attrs.each { |key, value| send("#{key}=", value) }
+  end
+
+  def eql?(other)
+    other.class == self.class && other.id == id
+  end
+
+  alias == eql?
+end

data/lib/scam/version.rb

@@ -0,0 +1,3 @@
+module Scam
+  VERSION = "0.2.0"
+end

data/scam.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "scam/version"
+
+Gem::Specification.new do |s|
+  s.name        = "scam"
+  s.version     = Scam::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["John Nunemaker"]
+  s.email       = ["nunemaker@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Really basic fake model for type-ish stuff}
+  s.description = %q{Really basic fake model for type-ish stuff}
+
+  s.add_development_dependency 'rspec', '~> 2.3'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/spec/helper.rb

@@ -0,0 +1,17 @@
+$:.unshift(File.expand_path('../../lib', __FILE__))
+
+require 'rubygems'
+require 'bundler'
+
+Bundler.require(:default, :development)
+
+require 'scam'
+require 'support/constants'
+
+Rspec.configure do |config|
+  config.include(Support::Constants)
+
+  config.before(:each) do
+
+  end
+end

data/spec/scam_spec.rb

@@ -0,0 +1,155 @@
+require 'helper'
+
+describe Scam do
+  uses_constants('FeedTemplate')
+
+  context "including Scam" do
+    it "adds id attr accessor" do
+      template = FeedTemplate.new
+      template.id = 5
+      template.id.should == 5
+    end
+  end
+
+  context "class enumerable" do
+    it "works" do
+      t1 = FeedTemplate.create(:id => 1)
+      t2 = FeedTemplate.create(:id => 2)
+      FeedTemplate.inject([]) { |acc, t| acc << t; acc }.should == [t1, t2]
+      FeedTemplate.detect { |t| t.id == 1 }.should == t1
+    end
+  end
+
+  describe ".sorted_by" do
+    it "defaults to id" do
+      FeedTemplate.sorted_by.should == :id
+    end
+
+    it "gets/sets sorted_by" do
+      FeedTemplate.sorted_by(:position)
+      FeedTemplate.sorted_by.should == :position
+    end
+  end
+
+  describe ".all" do
+    context "default sort by" do
+      before do
+        FeedTemplate.create(:id => 2)
+        FeedTemplate.create(:id => 1)
+      end
+
+      it "returns all instances sorted by id" do
+        FeedTemplate.all.map(&:id).should == [1, 2]
+      end
+    end
+
+    context "custom sort by" do
+      before do
+        FeedTemplate.sorted_by(:position)
+        FeedTemplate.send(:attr_accessor, :position)
+        FeedTemplate.create(:id => 2, :position => 1)
+        FeedTemplate.create(:id => 1, :position => 2)
+      end
+
+      it "returns all instances sorted by custom attribute" do
+        FeedTemplate.all.map(&:id).should == [2, 1]
+      end
+    end
+  end
+
+  describe ".initialize" do
+    before do
+      @template = FeedTemplate.new(:id => 5)
+    end
+
+    it "sets attributes" do
+      @template.id.should == 5
+    end
+  end
+
+  describe ".find" do
+    before do
+      @template = FeedTemplate.create(:id => 1)
+    end
+
+    context "with integer id" do
+      it "returns instance if found" do
+        FeedTemplate.find(1).should == @template
+      end
+    end
+
+    context "with string id" do
+      it "returns instance if found" do
+        FeedTemplate.find('1').should == @template
+      end
+    end
+
+    it "returns nil if not found" do
+      FeedTemplate.find(20000000000).should be_nil
+    end
+  end
+
+  describe ".[]" do
+    before do
+      @template = FeedTemplate.create(:id => 1)
+    end
+
+    context "with integer id" do
+      it "returns instance if found" do
+        FeedTemplate[1].should == @template
+      end
+    end
+
+    context "with string id" do
+      it "returns instance if found" do
+        FeedTemplate['1'].should == @template
+      end
+    end
+
+    it "returns nil if not found" do
+      FeedTemplate[1111122].should be_nil
+    end
+  end
+
+  describe ".create" do
+    before do
+      @template = FeedTemplate.create(:id => 1)
+    end
+
+    it "returns instance" do
+      @template.should be_instance_of(FeedTemplate)
+    end
+
+    it "adds model to list" do
+      FeedTemplate.should include(@template)
+    end
+  end
+
+  describe "#eql?" do
+    it "returns true if same class and id" do
+      FeedTemplate.new(:id => 1).should eql(FeedTemplate.new(:id => 1))
+    end
+
+    it "returns false if different class" do
+      FeedTemplate.new(:id => 1).should_not eql(Class.new.new)
+    end
+
+    it "returns false if different id" do
+      FeedTemplate.new(:id => 1).should_not eql(FeedTemplate.new(:id => 2))
+    end
+  end
+
+  describe "#==" do
+    it "returns true if same class and id" do
+      FeedTemplate.new(:id => 1).should == FeedTemplate.new(:id => 1)
+    end
+
+    it "returns false if different class" do
+      FeedTemplate.new(:id => 1).should_not == Class.new.new
+    end
+
+    it "returns false if different id" do
+      FeedTemplate.new(:id => 1).should_not == FeedTemplate.new(:id => 2)
+    end
+  end
+end

data/spec/support/constants.rb

@@ -0,0 +1,40 @@
+module Support
+  module Constants
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def uses_constants(*constants)
+        before { create_constants(*constants) }
+      end
+    end
+
+    def create_constants(*constants)
+      constants.each { |constant| create_constant(constant) }
+    end
+
+    def remove_constants(*constants)
+      constants.each { |constant| remove_constant(constant) }
+    end
+
+    def create_constant(constant)
+      remove_constant(constant)
+      Object.const_set(constant, Model(constant))
+    end
+
+    def remove_constant(constant)
+      Object.send(:remove_const, constant) if Object.const_defined?(constant)
+    end
+
+    def Model(name=nil)
+      Class.new.tap do |model|
+        model.class_eval """
+          def self.name; '#{name}' end
+          def self.to_s; '#{name}' end
+        """ if name
+        model.send(:include, Scam)
+      end
+    end
+  end
+end

data/specs.watchr

@@ -0,0 +1,45 @@
+def growl(title, msg, img)
+  %x{growlnotify -m #{ msg.inspect} -t #{title.inspect} --image ~/.watchr/#{img}.png}
+end
+
+def form_growl_message(str)
+  msg = str.split("\n").last
+  if msg =~ /(\d)\sfailure/
+    img = $1.to_i > 0 ? 'fail' : 'pass'
+  end
+  growl 'Results', msg, img
+end
+
+def run(cmd)
+  puts cmd
+  output = ""
+  IO.popen(cmd) do |com|
+    com.each_char do |c|
+      print c
+      output << c
+      $stdout.flush
+    end
+  end
+  form_growl_message output
+end
+
+def run_spec(path)
+  path.gsub!('lib/', 'spec/')
+  path.gsub!('_spec', '')
+  file_name = File.basename(path, '.rb')
+  path.gsub!(file_name, file_name + "_spec")
+  run %Q(bundle exec rspec #{path})
+end
+
+watch('spec/helper\.rb')  { system('clear'); run('rake') }
+watch('lib/.*\.rb')       { |m| system('clear'); run_spec(m[0]) }
+watch('spec/.*_spec\.rb') { |m| system('clear'); run_spec(m[0]) }
+
+# Ctrl-\
+Signal.trap('QUIT') do
+  puts " --- Running all tests ---\n\n"
+  run('rake')
+end
+
+# Ctrl-C
+Signal.trap('INT') { abort("\n") }

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification 
+name: scam
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- John Nunemaker
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-28 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 2
+        - 3
+        version: "2.3"
+  type: :development
+  version_requirements: *id001
+description: Really basic fake model for type-ish stuff
+email: 
+- nunemaker@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.rdoc
+- Rakefile
+- examples/simple.rb
+- examples/sorted.rb
+- lib/scam.rb
+- lib/scam/version.rb
+- scam.gemspec
+- spec/helper.rb
+- spec/scam_spec.rb
+- spec/support/constants.rb
+- specs.watchr
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Really basic fake model for type-ish stuff
+test_files: 
+- spec/helper.rb
+- spec/scam_spec.rb
+- spec/support/constants.rb