kashmir 0.1

data/test/inline_dsl_test.rb

@@ -0,0 +1,108 @@
+require 'test_helper'
+
+describe Kashmir::InlineDsl do
+
+  module InlineDSLTesting
+    class Recipe < OpenStruct
+      include Kashmir
+
+      representations do
+        rep(:num_steps)
+        rep(:title)
+        rep(:chef)
+      end
+    end
+
+    class Chef < OpenStruct
+      include Kashmir
+
+      representations do
+        rep(:full_name)
+        rep(:award)
+      end
+
+      def full_name
+        "#{first_name} #{last_name}"
+      end
+    end
+
+    class Award < OpenStruct
+      include Kashmir
+
+      representations do
+        base([:name, :year])
+      end
+    end
+  end
+
+  before do
+    @award   = InlineDSLTesting::Award.new(name: 'Best Chef', year: 2015)
+    @chef    = InlineDSLTesting::Chef.new(first_name: 'Netto', last_name: 'Farah', award: @award)
+    @brisket = InlineDSLTesting::Recipe.new(title: 'BBQ Brisket', num_steps: 2, chef: @chef)
+  end
+
+  it 'creates an inline representer' do
+    inline_representer = Kashmir::InlineDsl.build do
+      prop :num_steps
+      prop :title
+    end
+
+    assert_equal inline_representer.definitions, [:num_steps, :title]
+
+    cooked_brisket = @brisket.represent(inline_representer.definitions)
+    assert_equal cooked_brisket, { title: 'BBQ Brisket', num_steps: 2 }
+  end
+
+  describe 'Reduced syntax' do
+
+    describe '#represent_with' do
+      it 'works with flat representers' do
+        cooked_brisket = @brisket.represent_with do
+          prop :title
+          prop :num_steps
+        end
+
+        assert_equal cooked_brisket, { title: 'BBQ Brisket', num_steps: 2 }
+      end
+
+      it 'works with nested representers' do
+        cooked_brisket = @brisket.represent_with do
+          prop :title
+          prop :num_steps
+
+          inline :chef do
+            prop :full_name
+          end
+        end
+
+        assert_equal cooked_brisket, {
+          title: 'BBQ Brisket',
+          num_steps: 2,
+          chef: {
+            full_name: 'Netto Farah'
+          }
+        }
+      end
+    end
+
+    it 'works with multi level nested representers' do
+      cooked_brisket = @brisket.represent_with do
+        prop :title
+        inline :chef do
+          prop :full_name
+          inline :award
+        end
+      end
+
+      assert_equal cooked_brisket, {
+        title: 'BBQ Brisket',
+        chef: {
+          full_name: 'Netto Farah',
+          award: {
+            name: 'Best Chef', year: 2015
+          }
+        }
+      }
+    end
+  end
+end

data/test/kashmir_test.rb

@@ -0,0 +1,216 @@
+require 'test_helper'
+
+describe Kashmir do
+
+  class Recipe < OpenStruct
+    include Kashmir
+
+    representations do
+      base([:title, :preparation_time])
+      rep(:num_steps)
+      rep(:chef)
+    end
+
+    def num_steps
+      steps.size
+    end
+  end
+
+  class Chef < OpenStruct
+    include Kashmir
+
+    representations do
+      base([:name])
+    end
+  end
+
+  before(:each) do
+    @recipe = Recipe.new(title: 'Beef stew', preparation_time: 60)
+    @chef = Chef.new(name: 'Netto')
+  end
+
+  it 'renders basic attribute representations' do
+    assert_equal @recipe.represent, { title: 'Beef stew', preparation_time: 60 }
+  end
+
+  it 'renders basic calculated representations' do
+    @recipe.steps = ['chop', 'cook']
+    assert_equal @recipe.represent([:num_steps]), {
+      title: 'Beef stew',
+      preparation_time: 60,
+      num_steps: 2
+    }
+  end
+
+  it 'renders nested representations' do
+    @recipe.chef = @chef
+    representation = @recipe.represent([:chef])
+    assert_equal representation[:chef], { name: 'Netto' }
+  end
+end
+
+describe 'Complex Representations' do
+  class BBQRecipe < OpenStruct
+    include Kashmir
+
+    representations do
+      base([:title])
+      rep(:chef)
+    end
+  end
+
+  class BBQChef < OpenStruct
+    include Kashmir
+
+    representations do
+      base([:name])
+      rep(:restaurant)
+    end
+  end
+
+  class BBQRestaurant < OpenStruct
+    include Kashmir
+
+    representations do
+      base([:name])
+      rep(:rating)
+    end
+  end
+
+  before do
+    @bbq_joint = BBQRestaurant.new(name: "Netto's BBQ Joint", rating: '5 stars')
+    @netto = BBQChef.new(name: 'Netto', restaurant: @bbq_joint)
+    @brisket = BBQRecipe.new(title: 'BBQ Brisket', chef: @netto)
+  end
+
+  it 'works with base representations' do
+    assert_equal @netto.represent,     { name: 'Netto' }
+    assert_equal @brisket.represent,   { title: 'BBQ Brisket' }
+    assert_equal @bbq_joint.represent, { name: "Netto's BBQ Joint" }
+  end
+
+  it 'works with simple nesting' do
+    representation = @netto.represent([:restaurant])
+    assert_equal representation, {
+      name: 'Netto',
+      restaurant: { name: "Netto's BBQ Joint" }
+    }
+  end
+
+  it 'allows clients to customize nested representations' do
+    representation = @netto.represent [{ :restaurant => [:rating] }]
+
+    assert_equal representation, {
+      name: 'Netto',
+      restaurant: { name: "Netto's BBQ Joint", rating: '5 stars' }
+    }
+  end
+
+  it 'allows clients to create complex representation trees' do
+    representation = @brisket.represent([
+      :chef => [
+        { :restaurant => [ :rating ] }
+      ]
+    ])
+
+    assert_equal representation, {
+      title: 'BBQ Brisket',
+      chef: {
+        name: 'Netto',
+        restaurant: {
+          name: "Netto's BBQ Joint",
+          rating: '5 stars'
+        }
+      }
+    }
+  end
+end
+
+describe 'Collections' do
+
+  class Ingredient < OpenStruct
+    include Kashmir
+
+    representations do
+      rep(:name)
+      rep(:quantity)
+    end
+  end
+
+  class ClassyRecipe < OpenStruct
+    include Kashmir
+
+    representations do
+      rep(:title)
+      rep(:ingredients)
+    end
+  end
+
+  before(:each) do
+    @omelette = ClassyRecipe.new(title: 'Omelette Du Fromage')
+    @omelette.ingredients = [
+      Ingredient.new(name: 'Egg', quantity: 2),
+      Ingredient.new(name: 'Cheese', quantity: 'a lot!')
+    ]
+  end
+
+  it 'represents collections' do
+    nice_omelette = @omelette.represent([:title, { :ingredients => [ :name, :quantity ]}])
+
+    assert_equal nice_omelette, {
+      title: 'Omelette Du Fromage',
+      ingredients: [
+        { name: 'Egg', quantity: 2 },
+        { name: 'Cheese', quantity: 'a lot!' }
+      ]
+    }
+  end
+end
+
+describe "Hashes" do
+
+  class RecipeCategories < OpenStruct
+    include Kashmir
+
+    representations do
+      rep :categories
+    end
+  end
+
+  before(:each) do
+    @omelette = ClassyRecipe.new(title: 'Omelette Du Fromage')
+    @scrambled_eggs = ClassyRecipe.new(title: 'Scrambled Eggs')
+
+    @brisket = ClassyRecipe.new(title: 'Briksket')
+    @ribs = ClassyRecipe.new(title: 'BBQ Ribs')
+
+    @categories = [
+      { name: 'Breakfast', recipes: [ @omelette, @scrambled_eggs] },
+      { name: 'Dinner', recipes: [ @brisket, @ribs ] }
+    ]
+  end
+
+  it 'represents hashes' do
+    representation = RecipeCategories.new(categories: @categories).represent([{
+      categories: [
+        :name,
+        recipes: [:title]
+      ]
+    }])
+
+    assert_equal representation, {
+      categories: [
+        {
+          name: "Breakfast", recipes: [
+            { title: "Omelette Du Fromage" }, { title: "Scrambled Eggs" }
+          ]
+        },
+        {
+          name: "Dinner", recipes: [
+            { title: "Briksket" }, { title: "BBQ Ribs" }
+          ]
+        }
+      ]
+    }
+  end
+end

data/test/support/ar_models.rb

@@ -0,0 +1,69 @@
+module AR
+  class Recipe < ActiveRecord::Base
+    include Kashmir
+
+    belongs_to :chef
+    has_many :recipes_ingredients
+    has_many :ingredients, through: :recipes_ingredients
+
+    representations do
+      rep :title
+      rep :chef
+      rep :ingredients
+    end
+  end
+
+  class Ingredient < ActiveRecord::Base
+    include Kashmir
+
+    representations do
+      rep :name
+      rep :quantity
+    end
+  end
+
+  class RecipesIngredient < ActiveRecord::Base
+    belongs_to :recipe
+    belongs_to :ingredient
+  end
+
+  class Restaurant < ActiveRecord::Base
+    include Kashmir
+
+    belongs_to :owner, class_name: 'Chef'
+    has_one :rating
+
+    representations do
+      rep :name
+      rep :owner
+      rep :rating
+
+      rep :current_customer_count, cacheable: false
+    end
+  end
+
+  class Rating < ActiveRecord::Base
+    include Kashmir
+
+    belongs_to :restaurant
+
+    representations do
+      rep :value
+    end
+  end
+
+  class Chef < ActiveRecord::Base
+    include Kashmir
+
+    has_many :recipes
+    has_many :ingredients, through: :recipes
+    has_one  :restaurant, foreign_key: 'owner_id'
+
+    representations do
+      rep :name
+      rep :recipes
+      rep :ingredients
+      rep :restaurant
+    end
+  end
+end

data/test/support/factories.rb

@@ -0,0 +1,33 @@
+module TestData
+  def self.create_tom
+    AR::Chef.create(name: 'Tom').tap do |tom|
+      AR::Recipe.create(title: 'Pastrami Sandwich', chef: tom).tap do |r|
+        r.ingredients.create(name: 'Pastrami', quantity: 'a lot')
+        r.ingredients.create(name: 'Cheese', quantity: '1 slice')
+      end
+
+      AR::Recipe.create(title: 'Belly Burger', chef: tom).tap do |r|
+        r.ingredients.create(name: 'Pork Belly', quantity: 'plenty')
+        r.ingredients.create(name: 'Green Apple', quantity: '2 slices')
+      end
+
+      AR::Restaurant.create(name: 'Chef Tom Belly Burgers', owner: tom) do |res|
+        res.create_rating(value: '3 stars')
+      end
+    end
+  end
+
+  def self.create_netto
+    AR::Chef.create(name: 'Netto').tap do |netto|
+      AR::Recipe.create(title: 'Turkey Sandwich', chef: netto).tap do |r|
+        r.ingredients.create(name: 'Turkey', quantity: 'a lot')
+        r.ingredients.create(name: 'Cheese', quantity: '1 slice')
+      end
+
+      AR::Recipe.create(title: 'Cheese Burger', chef: netto).tap do |r|
+        r.ingredients.create(name: 'Patty', quantity: '1')
+        r.ingredients.create(name: 'Cheese', quantity: '2 slices')
+      end
+    end
+  end
+end

data/test/support/schema.rb

@@ -0,0 +1,32 @@
+ActiveRecord::Schema.define do
+  create_table :recipes, force: true do |t|
+    t.column :title, :string
+    t.column :num_steps, :integer
+    t.column :chef_id, :integer
+  end
+
+  create_table :ingredients, force: true do |t|
+    t.column :name, :string
+    t.column :quantity, :string
+  end
+
+  create_table :recipes_ingredients, force: true do |t|
+    t.column :recipe_id, :integer
+    t.column :ingredient_id, :integer
+  end
+
+  create_table :chefs, force: true do |t|
+    t.column :name, :string
+  end
+
+  create_table :restaurants, force: true do |t|
+    t.column :name, :string
+    t.column :owner_id, :integer
+    t.column :current_customer_count, :integer
+  end
+
+  create_table :ratings, force: true do |t|
+    t.column :value, :string
+    t.column :restaurant_id, :integer
+  end
+end