representable 2.4.1 → 3.0.0

data/test-with-deprecations/example.rb

@@ -1,310 +0,0 @@
-require 'bundler'
-Bundler.setup
-
-require 'representable/yaml'
-require 'ostruct'
-
-def reset_representer(*module_name)
-  module_name.each do |mod|
-    mod.module_eval do
-      @representable_attrs = nil
-    end
-  end
-end
-
-class Song < OpenStruct
-end
-
-song = Song.new(:title => "Fallout", :track => 1)
-
-require 'representable/json'
-module SongRepresenter
-  include Representable::JSON
-
-  property :title
-  property :track
-end
-
-puts song.extend(SongRepresenter).to_json
-
-rox = Song.new.extend(SongRepresenter).from_json(%{ {"title":"Roxanne"} })
-puts rox.inspect
-
-module SongRepresenter
-  include Representable::JSON
-
-  self.representation_wrap= :hit
-
-  property :title
-  property :track
-end
-
-puts song.extend(SongRepresenter).to_json
-
-
-
-######### collections
-
-reset_representer(SongRepresenter)
-
-module SongRepresenter
-  include Representable::JSON
-
-  property :title
-  property :track
-  collection :composers
-end
-
-
-song = Song.new(:title => "Fallout", :composers => ["Stewart Copeland", "Sting"])
-puts song.extend(SongRepresenter).to_json
-
-
-######### nesting types
-
-class Album < OpenStruct
-  def name
-    puts @table.inspect
-    #@attributes
-    @table[:name]
-  end
-end
-
-module AlbumRepresenter
-  include Representable::JSON
-
-  property :name
-  property :song, :extend => SongRepresenter, :class => Song
-end
-
-album = Album.new(:name => "The Police", :song => song)
-puts album.extend(AlbumRepresenter).to_json
-
-reset_representer(AlbumRepresenter)
-
-module AlbumRepresenter
-  include Representable::JSON
-
-  property :name
-  collection :songs, :extend => SongRepresenter, :class => Song
-end
-
-album = Album.new(:name => "The Police", :songs => [song, Song.new(:title => "Synchronicity")])
-puts album.extend(AlbumRepresenter).to_json
-
-
-album = Album.new.extend(AlbumRepresenter).from_json(%{{"name":"Offspring","songs":[{"title":"Genocide"},{"title":"Nitro","composers":["Offspring"]}]}
-})
-puts album.inspect
-
-reset_representer(SongRepresenter)
-
-######### using helpers (customizing the rendering/parsing) 
-module AlbumRepresenter
-  include Representable::JSON
-
-  def name
-    super.upcase
-  end
-end
-
-puts Album.new(:name => "The Police").
-  extend(AlbumRepresenter).to_json
-
-reset_representer(SongRepresenter)
-
-
-######### inheritance
-module SongRepresenter
-  include Representable::JSON
-
-  property :title
-  property :track
-end
-
-module CoverSongRepresenter
-  include Representable::JSON
-  include SongRepresenter
-
-  property :covered_by
-end
-
-
-song = Song.new(:title => "Truth Hits Everybody", :covered_by => "No Use For A Name")
-puts song.extend(CoverSongRepresenter).to_json
-
-
-### XML
-require 'representable/xml'
-module SongRepresenter
-  include Representable::XML
-
-  property :title
-  property :track
-  collection :composers
-end
-song = Song.new(:title => "Fallout", :composers => ["Stewart Copeland", "Sting"])
-puts song.extend(SongRepresenter).to_xml
-
-reset_representer(SongRepresenter)
-
-
-### YAML
-require 'representable/yaml'
-module SongRepresenter
-  include Representable::YAML
-
-  property :title
-  property :track
-  collection :composers
-end
-puts song.extend(SongRepresenter).to_yaml
-
-
-SongRepresenter.module_eval do
-  @representable_attrs = nil
-end
-
-
-### YAML
-module SongRepresenter
-  include Representable::YAML
-
-  property :title
-  property :track
-  collection :composers, :style => :flow
-end
-puts song.extend(SongRepresenter).to_yaml
-
-SongRepresenter.module_eval do
-  @representable_attrs = nil
-end
-
-# R/W support
-song = Song.new(:title => "You're Wrong", :track => 4)
-module SongRepresenter
-  include Representable::Hash
-
-  property :title, :readable => false
-  property :track
-end
-puts song.extend(SongRepresenter).to_hash
-
-SongRepresenter.module_eval do
-  @representable_attrs = nil
-end
-
-module SongRepresenter
-  include Representable::Hash
-
-  property :title, :writeable => false
-  property :track
-end
-song = Song.new.extend(SongRepresenter)
-song.from_hash({:title => "Fallout", :track => 1})
-puts song
-
-######### custom methods in representer (using helpers)
-######### conditions
-######### :as
-######### XML::Collection
-######### polymorphic :extend and :class, instance context!, :instance
-class CoverSong < Song
-end
-
-songs = [Song.new(title: "Weirdo", track: 5), CoverSong.new(title: "Truth Hits Everybody", track: 6, copyright: "The Police")]
-album = Album.new(name: "Incognito", songs: songs)
-
-
-reset_representer(SongRepresenter, AlbumRepresenter)
-
-module SongRepresenter
-  include Representable::Hash
-
-  property :title
-  property :track
-end
-
-module CoverSongRepresenter
-  include Representable::Hash
-  include SongRepresenter
-
-  property :copyright
-end
-
-module AlbumRepresenter
-  include Representable::Hash
-
-  property :name
-  collection :songs, :extend => lambda { |song| song.is_a?(CoverSong) ? CoverSongRepresenter : SongRepresenter }
-end
-
-puts album.extend(AlbumRepresenter).to_hash
-
-reset_representer(AlbumRepresenter)
-
-module AlbumRepresenter
-  include Representable::Hash
-
-  property :name
-  collection :songs, 
-    :extend => lambda { |song| song.is_a?(CoverSong) ? CoverSongRepresenter : SongRepresenter },
-    :class  => lambda { |hsh| hsh.has_key?("copyright") ? CoverSong : Song } #=> {"title"=>"Weirdo", "track"=>5}
-end
-
-album = Album.new.extend(AlbumRepresenter).from_hash({"name"=>"Incognito", "songs"=>[{"title"=>"Weirdo", "track"=>5}, {"title"=>"Truth Hits Everybody", "track"=>6, "copyright"=>"The Police"}]})
-puts album.inspect
-
-reset_representer(AlbumRepresenter)
-
-module AlbumRepresenter
-  include Representable::Hash
-
-  property :name
-  collection :songs, 
-    :extend   => lambda { |song| song.is_a?(CoverSong) ? CoverSongRepresenter : SongRepresenter },
-    :instance => lambda { |hsh| hsh.has_key?("copyright") ? CoverSong.new : Song.new(original: true) }
-end
-
-album = Album.new.extend(AlbumRepresenter).from_hash({"name"=>"Incognito", "songs"=>[{"title"=>"Weirdo", "track"=>5}, {"title"=>"Truth Hits Everybody", "track"=>6, "copyright"=>"The Police"}]})
-puts album.inspect
-
-######### #hash
-
-reset_representer(SongRepresenter)
-
-module SongRepresenter
-  include Representable::JSON
-
-  property :title
-  hash :ratings
-end
-
-puts Song.new(title: "Bliss", ratings: {"Rolling Stone" => 4.9, "FryZine" => 4.5}).extend(SongRepresenter).to_json
-
-######### JSON::Hash
-
-module FavoriteSongsRepresenter
-  include Representable::JSON::Hash
-end
-
-puts( {"Nick" => "Hyper Music", "El" => "Blown In The Wind"}.extend(FavoriteSongsRepresenter).to_json)
-
-require 'representable/json/hash'
-module FavoriteSongsRepresenter
-  include Representable::JSON::Hash
-
-  values extend: SongRepresenter, class: Song
-end
-
-puts( {"Nick" => Song.new(title: "Hyper Music")}.extend(FavoriteSongsRepresenter).to_json)
-
-
-require 'representable/json/collection'
-module SongsRepresenter
-  include Representable::JSON::Collection
-
-  items extend: SongRepresenter, class: Song
-end
-
-puts [Song.new(title: "Hyper Music"), Song.new(title: "Screenager")].extend(SongsRepresenter).to_json

data/test-with-deprecations/examples/object.rb

@@ -1,31 +0,0 @@
-require "test_helper"
-
-require "ostruct"
-require "pp"
-
-
-source = OpenStruct.new(name: "30 Years Live", songs: [
-  OpenStruct.new(id: 1, title: "Dear Beloved"), OpenStruct.new(id: 2, title: "Fuck Armageddon")])
-
-pp source
-
-require "representable/object"
-
-class AlbumRepresenter < Representable::Decorator
-  include Representable::Object
-
-  property :name
-  collection :songs, instance: ->(fragment, *) { Song.new } do
-    property :title
-  end
-end
-
-
-Album = Struct.new(:name, :songs)
-Song = Struct.new(:title)
-
-target = Album.new
-
-AlbumRepresenter.new(target).from_object(source)
-
-pp target

data/test-with-deprecations/exec_context_test.rb

@@ -1,93 +0,0 @@
-require 'test_helper'
-
-class ExecContextTest < MiniTest::Spec
-  for_formats(
-    :hash => [Representable::Hash, {Song => "Rebel Fate"}, {Song=>"Timing"}],
-    # :xml  => [Representable::XML, "<open_struct>\n  <song>\n    <name>Alive</name>\n  </song>\n</open_struct>", "<open_struct><song><name>You've Taken Everything</name></song>/open_struct>"],
-    # :yaml => [Representable::YAML, "---\nsong:\n  name: Alive\n", "---\nsong:\n  name: You've Taken Everything\n"],
-  ) do |format, mod, input, output|
-
-    let (:song) { representer.prepare(Song.new("Timing")) }
-    let (:format) { format }
-
-
-    describe "exec_context: nil" do
-      representer!(:module => mod) do
-        property :name, :as => lambda { |*| self.class }
-      end
-
-      it { render(song).must_equal_document output }
-      it { parse(song, input).name.must_equal "Rebel Fate" }
-    end
-
-
-    describe "exec_context: :decorator" do
-      representer!(:module => mod) do
-        property :name, :as => lambda { |*| self.class }, :exec_context => :decorator
-      end
-
-      it { render(song).must_equal_document output }
-      it { parse(song, input).name.must_equal "Rebel Fate" }
-    end
-
-
-    describe "exec_context: :binding" do
-      representer!(:module => mod) do
-        property :name,
-          :as           => lambda { |*| self.class }, # to actually test
-          :exec_context => :binding,
-          :setter        => lambda { |v, *args| represented.name = v # to make parsing work.
-        }
-      end
-
-      it { render(song).must_equal_document({Representable::Hash::Binding => "name"}) }
-      it { parse(song, {Representable::Hash::Binding => "Rebel Fate"}).name.must_equal "Rebel Fate" }
-    end
-
-
-    describe "Decorator" do
-      # DISCUSS: do we need this test?
-      describe "exec_context: nil" do
-        representer!(:module => mod, :decorator => true) do
-          property :name, :as => lambda { |*| self.class }
-        end
-
-        it { render(song).must_equal_document output }
-        it { parse(song, input).name.must_equal "Rebel Fate" }
-      end
-
-
-      describe "exec_context: :decorator" do # this tests if lambdas are run in the right context, if methods are called in the right context and if we can access the represented object.
-        representer!(:module => mod, :decorator => true) do
-          property :name, :as => lambda { |*| self.class.superclass }, :exec_context => :decorator
-
-          define_method :name do # def in Decorator class.
-            "Timebomb"
-          end
-
-          define_method :"name=" do |v| # def in Decorator class.
-            represented.name = v
-          end
-        end
-
-        it { render(song).must_equal_document({Representable::Decorator=>"Timebomb"}) }
-        it { parse(song, {Representable::Decorator=>"Listless"}).name.must_equal "Listless" }
-      end
-
-
-      # DISCUSS: do we need this test?
-      describe "exec_context: :binding" do
-        representer!(:module => mod, :decorator => true) do
-          property :name,
-            :as           => lambda { |*| self.class }, # to actually test
-            :exec_context => :binding,
-            :setter        => lambda { |v, *args| represented.name = v # to make parsing work.
-          }
-        end
-
-        it { render(song).must_equal_document({Representable::Hash::Binding => "name"}) }
-        it("xxx") { parse(song, {Representable::Hash::Binding => "Rebel Fate"}).name.must_equal "Rebel Fate" }
-      end
-    end
-  end
-end

data/test-with-deprecations/features_test.rb

@@ -1,70 +0,0 @@
-require 'test_helper'
-
-class FeaturesTest < MiniTest::Spec
-  module Title
-    def title; "Is It A Lie"; end
-  end
-  module Length
-    def length; "2:31"; end
-  end
-
-  definition = lambda {
-    feature Title
-    feature Length
-
-    # exec_context: :decorator, so the readers are called on the Decorator instance (which gets readers from features!).
-    property :title, exec_context: :decorator
-    property :length, exec_context: :decorator
-    property :details do
-      property :title, exec_context: :decorator
-    end
-  }
-
-  let (:song) { OpenStruct.new(:details => Object.new) }
-
-  describe "Module" do
-    representer! do
-      instance_exec &definition
-    end
-
-    it { song.extend(representer).to_hash.must_equal({"title"=>"Is It A Lie", "length"=>"2:31", "details"=>{"title"=>"Is It A Lie"}}) }
-  end
-
-
-  describe "Decorator" do
-    representer!(:decorator => true) do
-      instance_exec &definition
-    end
-
-    it { representer.new(song).to_hash.must_equal({"title"=>"Is It A Lie", "length"=>"2:31", "details"=>{"title"=>"Is It A Lie"}}) }
-  end
-end
-
-class FeatureInclusionOrderTest < MiniTest::Spec
-  module Title
-    def title
-      "I was first!"
-    end
-  end
-
-  module OverridingTitle
-    def title
-      "I am number two, " + super
-    end
-  end
-
-  representer!(decorator: true) do
-    feature Title
-    feature OverridingTitle
-
-    property :title, exec_context: :decorator
-
-    property :song do
-      property :title, exec_context: :decorator
-    end
-  end
-
-  it do
-    representer.new(OpenStruct.new(song: Object)).to_hash.must_equal({"title"=>"I am number two, I was first!", "song"=>{"title"=>"I am number two, I was first!"}})
-  end
-end