serialization_scopes 0.1.0

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+pkg/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'http://rubygems.org'
+
+gem "activerecord", '< 3.0.0'
+gem "rspec"
+gem "rake"
+gem "jeweler"

data/Rakefile

@@ -0,0 +1,29 @@
+require 'bundler'
+Bundler.setup
+
+require 'rake'
+require 'spec/rake/spectask'
+
+desc 'Run specs.'
+Spec::Rake::SpecTask.new('spec') do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.spec_opts = ["-c"]
+end
+
+desc 'Default: run specs.'
+task :default => :spec
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "serialization_scopes"
+    gemspec.summary = "Named scopes for ActiveRecord serialization methods (to_xml, to_json)"
+    gemspec.description = "Adds named scopes for ActiveRecord serialization methods (to_xml, to_json)"
+    gemspec.email = "dimitrij@blacksquaremedia.com"
+    gemspec.homepage = "http://github.com/dim/serialization_scopes"
+    gemspec.authors = ["Dimitrij Denissenko"]
+    gemspec.add_runtime_dependency "activerecord", ">= 2.3.0", '< 3.0.0'
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/serialization_scopes.rb

@@ -0,0 +1,33 @@
+module SerializationScopes
+
+  def self.included(base)
+    base.extend ClassMethods
+    base.class_inheritable_reader    :serialization_scopes
+    base.write_inheritable_attribute :serialization_scopes, {}
+  end
+
+  module ClassMethods
+    def serialization_scope(name, options = {})
+      serialization_scopes[name.to_sym] = options
+    end
+
+    def scoped_serialization_options(options = {})
+      name   = options.delete(:scope)
+      scopes = name.present? && serialization_scopes[name.to_sym] ? serialization_scopes[name.to_sym] : serialization_scopes[:default]
+      scopes.each do |key, values|
+        options[key] ||= Array(values)
+        options[key] = Array(options[key]) & Array(values)
+      end if scopes
+      options
+    end
+  end
+
+  def to_xml(options = {})
+    super self.class.scoped_serialization_options(options)
+  end
+
+  def to_json(options = {})
+    super self.class.scoped_serialization_options(options)
+  end
+
+end

data/rails/init.rb

@@ -0,0 +1,4 @@
+require 'serialization_scopes'
+ActiveRecord::Base.class_eval do
+  include SerializationScopes
+end

data/serialization_scopes.gemspec

@@ -0,0 +1,49 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{serialization_scopes}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Dimitrij Denissenko"]
+  s.date = %q{2010-08-19}
+  s.description = %q{Adds named scopes for ActiveRecord serialization methods (to_xml, to_json)}
+  s.email = %q{dimitrij@blacksquaremedia.com}
+  s.files = [
+    ".gitignore",
+     "Gemfile",
+     "Rakefile",
+     "VERSION",
+     "lib/serialization_scopes.rb",
+     "rails/init.rb",
+     "serialization_scopes.gemspec",
+     "spec/helper.rb",
+     "spec/serialization_scopes_spec.rb"
+  ]
+  s.homepage = %q{http://github.com/dim/serialization_scopes}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Named scopes for ActiveRecord serialization methods (to_xml, to_json)}
+  s.test_files = [
+    "spec/helper.rb",
+     "spec/serialization_scopes_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activerecord>, [">= 2.3.0", "< 3.0.0"])
+    else
+      s.add_dependency(%q<activerecord>, [">= 2.3.0", "< 3.0.0"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, [">= 2.3.0", "< 3.0.0"])
+  end
+end
+

data/spec/helper.rb

@@ -0,0 +1,12 @@
+ENV["RAILS_ENV"] ||= 'test'
+$: << File.join(File.dirname(__FILE__),'..', 'lib')
+
+require 'rubygems'
+require 'active_record'
+
+require File.join(File.dirname(__FILE__),'..', 'rails', 'init.rb')
+require 'spec/autorun'
+require 'spec/mocks'
+
+ActiveRecord::Base.stub(:establish_connection)
+

data/spec/serialization_scopes_spec.rb

@@ -0,0 +1,63 @@
+require File.expand_path(File.dirname(__FILE__) + '/helper')
+
+describe SerializationScopes do
+
+  class SomeModel < ActiveRecord::Base
+    serialization_scope :default, :only => [:id, :name], :methods => :currency
+    serialization_scope :admin, :only => [:id, :secret]
+
+    def self.columns
+      @columns ||= [
+        ActiveRecord::ConnectionAdapters::Column.new('id', nil, 'integer'),
+        ActiveRecord::ConnectionAdapters::Column.new('name', nil, 'string'),
+        ActiveRecord::ConnectionAdapters::Column.new('secret', nil, 'string')
+      ]
+    end
+
+    def after_initialize
+      self.id     = 1
+      self.name   = 'Any'
+      self.secret = 'key'
+    end
+
+    def currency
+      'USD'
+    end
+  end
+
+  it 'should constraint to_xml' do
+    SomeModel.new.to_xml.should == %(<?xml version="1.0" encoding="UTF-8"?>
+<some-model>
+  <id type="integer">1</id>
+  <name>Any</name>
+  <currency>USD</currency>
+</some-model>
+)
+  end
+
+  def as_hash(options = {})
+    ActiveSupport::JSON.decode(SomeModel.new.to_json(options))
+  end
+
+  it 'should constraint to_json' do
+    as_hash.should == { "name" => "Any", "currency" => "USD", "id" => 1 }
+  end
+
+  it 'should allow further restrictions' do
+    as_hash(:only => :name).should == { "name" => "Any", "currency" => "USD" }
+    as_hash(:methods => []).should == { "name" => "Any", "id" => 1 }
+  end
+
+  it 'should deny extensions if (default) scope is selected' do
+    as_hash(:only => [:id, :secret]).should == { "id" => 1, "currency" => "USD" }
+  end
+
+  it 'should have separate behaviours for different scopes' do
+    as_hash(:scope => :admin).should == { "id" => 1, "secret" => "key" }
+  end
+
+  it 'should fallback to default scope if invalid scope is given' do
+    as_hash(:scope => :invalid).should == { "name" => "Any", "currency" => "USD", "id" => 1 }
+  end
+
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification 
+name: serialization_scopes
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Dimitrij Denissenko
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-19 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+    - - <
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  requirement: *id001
+  prerelease: false
+  type: :runtime
+  name: activerecord
+description: Adds named scopes for ActiveRecord serialization methods (to_xml, to_json)
+email: dimitrij@blacksquaremedia.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Rakefile
+- VERSION
+- lib/serialization_scopes.rb
+- rails/init.rb
+- serialization_scopes.gemspec
+- spec/helper.rb
+- spec/serialization_scopes_spec.rb
+has_rdoc: true
+homepage: http://github.com/dim/serialization_scopes
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: Named scopes for ActiveRecord serialization methods (to_xml, to_json)
+test_files: 
+- spec/helper.rb
+- spec/serialization_scopes_spec.rb