kuhsaft 2.3.0 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 67da27e272a61ce14b7b0f1f0c1cbf7f6bb5ffaa
-  data.tar.gz: 0a6cd02acddbcc083c6e21282dca46e1ee7afdf9
+  metadata.gz: c60f8ceefd0183f0e24eee551f4560d802969351
+  data.tar.gz: bc32915f907f3630621dea9ca3283d5961f0fdb9
 SHA512:
-  metadata.gz: ab2e3d901758c86dc668b3a3d891bc5c24b82d4b7e20effdb158c421e77dc81a73dd8a03566919f4526dd63984a78f8e3db41c0dcf320459d8f1c2db2feb6f8f
-  data.tar.gz: 7994bf1fdafcd117491681eec33296e7730a7da0597e9bbce2fb4e7496b45b7318ccd5717b5aa18b1aeda651f0ba45c7d3fe1de3e29d2b6691515b4306eeba78
+  metadata.gz: 5196609fd60806c055d1501f725d3347e5f875da67f952d3a4b249739cea4c80c82ba72665bd7a81e68c085ab1124b9d3eb0ace015cd9335aa609909480cb37c
+  data.tar.gz: a226eaf1a6674895c40d81655b82df983c174618cbc15693b5b7f5873e3cb84e7dcbc24c158180e471d74b44754f7529572cf1fb27a89a2b296871ac95f40e9e

data/README.md

@@ -193,6 +193,18 @@ de:
   your_partial: Your Partial
 ```
 
+## Invalidating placeholder bricks containing other models on model changes
+
+Include the TouchPlaceholders module if your model is used within a
+placeholder brick and define which templates it appears in:
+
+```ruby
+class Dummy < ActiveRecord::Base
+  include Kuhsaft::TouchPlaceholders
+  placeholder_templates 'some_template', 'some_other_template'
+end
+```
+
 ## Adding additional content languages
 
 If you want to translate your pages into another language, generate a new translation migration:

data/Rakefile

@@ -32,6 +32,13 @@ module Postgres
   end
 end
 
+def within_dummy_app
+  Dir.chdir('spec/dummy') do
+    ENV['BUNDLE_GEMFILE'] = File.join File.dirname(__FILE__), 'Gemfile'
+    yield
+  end
+end
+
 desc 'Run specs'
 RSpec::Core::RakeTask.new(spec: :setup)
 
@@ -46,7 +53,7 @@ end
 desc 'set up the dummy app for testing'
 task :setup do
   Postgres.create_user 'screenconcept'
-  Dir.chdir('spec/dummy') do
+  within_dummy_app do
     `bundle exec rake kuhsaft:install:migrations`
     `bundle exec rails generate kuhsaft:install:assets`
     `bundle exec rake db:create`
@@ -60,8 +67,16 @@ task default: [:spec]
 
 desc 'start the dummy app'
 task :start_dummy do
-  Dir.chdir('spec/dummy') do
-    ENV['BUNDLE_GEMFILE'] = '../../Gemfile'
+  within_dummy_app do
     `bundle exec rails server`
   end
 end
+
+namespace :dummy_db do
+  desc 'migrate in dummy app'
+  task :migrate do
+    within_dummy_app do
+      `bundle exec rake db:migrate 2>&1`
+    end
+  end
+end

data/app/models/kuhsaft/brick.rb

@@ -1,3 +1,5 @@
+require_relative '../../../lib/kuhsaft/brick_list'
+
 module Kuhsaft
   class Brick < ActiveRecord::Base
     include Kuhsaft::BrickList

data/app/models/kuhsaft/page.rb

@@ -31,6 +31,7 @@ module Kuhsaft
     validates :slug, presence: true
     validates :redirect_url, presence: true, if: :redirect?
     validates :title, :slug, :keywords, :page_type, length: { maximum: 255 }
+    validates :identifier, uniqueness: true, allow_blank: true
 
     class << self
       def flat_tree(pages = nil)
@@ -48,6 +49,10 @@ module Kuhsaft
 
         arr
       end
+
+      def by_identifier(identifier)
+        where(identifier: identifier).first
+      end
     end
 
     def without_self

data/app/models/kuhsaft/placeholder_brick.rb

@@ -1,3 +1,5 @@
+require_relative './brick'
+
 module Kuhsaft
   class PlaceholderBrick < Brick
     PARTIAL_PATH = '/app/views/kuhsaft/placeholder_bricks/partials/_*.haml'

data/db/migrate/20140327141200_add_identifier_to_kuhsaft_pages.rb

@@ -0,0 +1,6 @@
+class AddIdentifierToKuhsaftPages < ActiveRecord::Migration
+  def change
+    add_column :kuhsaft_pages, :identifier, :string
+    add_index :kuhsaft_pages, :identifier, unique: true
+  end
+end

data/lib/kuhsaft.rb

@@ -6,6 +6,7 @@ module Kuhsaft
   require 'kuhsaft/searchable'
   require 'kuhsaft/brick_list'
   require 'kuhsaft/partial_extractor'
+  require 'kuhsaft/touch_placeholders'
   require 'simple_form'
   require 'carrierwave'
   require 'rdiscount'

data/lib/kuhsaft/touch_placeholders.rb

@@ -0,0 +1,32 @@
+require_relative '../../app/models/kuhsaft/placeholder_brick'
+
+module Kuhsaft
+  module TouchPlaceholders
+    def self.included(base)
+      base.extend(ClassMethods)
+
+      base.class_eval do
+        after_save :touch_placeholders
+      end
+    end
+
+    def touch_placeholders
+      if self.class.placeholder_templates.present?
+        self.class.placeholder_templates.each do |template_name|
+          related_templates = Kuhsaft::PlaceholderBrick.where(template_name: template_name)
+          related_templates.each { |p| p.touch } if related_templates
+        end
+      end
+    end
+
+    module ClassMethods
+      def placeholder_templates(*attributes)
+        if attributes.empty?
+          @shoestrap_placeholder_templates
+        else
+          @shoestrap_placeholder_templates = attributes
+        end
+      end
+    end
+  end
+end

data/lib/kuhsaft/version.rb

@@ -1,3 +1,3 @@
 module Kuhsaft
-  VERSION = '2.3.0'
+  VERSION = '2.3.1'
 end

data/spec/factories.rb

@@ -15,6 +15,11 @@ FactoryGirl.define do
     tb.text 'DummyText'
   end
 
+  factory :placeholder_brick, class: 'Kuhsaft::PlaceholderBrick' do |tb|
+    tb.type 'Kuhsaft::PlaceholderBrick'
+    tb.template_name 'foo'
+  end
+
   factory :asset, class: Kuhsaft::Asset do |a|
     a.file File.open("#{Kuhsaft::Engine.root}/spec/dummy/app/assets/images/spec-image.png")
   end

data/spec/lib/touch_placeholders_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+require_relative '../../lib/kuhsaft/touch_placeholders'
+
+describe Kuhsaft::TouchPlaceholders do
+
+  before :all do
+    m = ActiveRecord::Migration.new
+    m.verbose = false
+    m.create_table :dummy_models do |t|
+      t.timestamps
+    end
+
+    class DummyModel < ActiveRecord::Base
+      include Kuhsaft::TouchPlaceholders
+    end
+
+    @page = FactoryGirl.create(:page)
+    @placeholder = FactoryGirl.create(:placeholder_brick, brick_list: @page, template_name: 'foo')
+  end
+
+  after :all do
+    m = ActiveRecord::Migration.new
+    m.verbose = false
+    m.drop_table :dummy_models
+
+    @page.destroy
+    @placeholder.destroy
+  end
+
+  describe 'placeholder_templates class method' do
+    it 'returns the attribute names defined with class macro' do
+      DummyModel.class_eval { placeholder_templates 'key_benefit_slider', 'key_benefit_grid' }
+      expect(DummyModel.placeholder_templates).to eq %w(key_benefit_slider key_benefit_grid)
+    end
+  end
+
+  describe 'after_save_callback' do
+    it 'looks for the bricks with affected templates and touches them' do
+      DummyModel.class_eval { placeholder_templates 'foo' }
+      expect_any_instance_of(Kuhsaft::PlaceholderBrick).to receive(:touch)
+      DummyModel.create
+    end
+  end
+end

data/spec/models/page_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe Kuhsaft::Page do
-  subject { described_class }
+  # subject { described_class }
 
   describe '.search' do
     before do
@@ -336,10 +336,10 @@ describe Kuhsaft::Page do
 
   describe '#fulltext' do
     let :page do
-      p = create(:page, keywords: 'key words', description: 'descrip tion', title: 'my title')
-      p.bricks << Kuhsaft::TextBrick.new(locale: I18n.locale, text: 'oh la la')
-      p.save
-      p
+      create(:page, keywords: 'key words', description: 'descrip tion', title: 'my title').tap do |p|
+        p.bricks << Kuhsaft::TextBrick.new(locale: I18n.locale, text: 'oh la la')
+        p.save
+      end
     end
 
     context 'when saved' do
@@ -437,4 +437,16 @@ describe Kuhsaft::Page do
       end
     end
   end
+
+  describe '#identifier' do
+    let(:cat_page) { create :page, identifier: 'cat_content' }
+
+    it 'should check for uniqueness' do
+      expect(build(:page, identifier: cat_page.identifier)).to be_invalid
+    end
+
+    it 'should be findable via scope' do
+      expect(Kuhsaft::Page.by_identifier(cat_page.identifier)).to eq(cat_page)
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,5 +1,5 @@
 # This file is copied to spec/ when you run 'rails generate rspec:install'
-ENV['RAILS_ENV'] ||= 'test'
+ENV['RAILS_ENV'] = 'test'
 require_relative File.expand_path('../dummy/config/environment.rb', __FILE__)
 require 'rspec/rails'
 require 'rspec/autorun'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kuhsaft
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.3.1
 platform: ruby
 authors:
 - Immanuel Häussermann
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-26 00:00:00.000000000 Z
+date: 2014-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -32,16 +32,16 @@ dependencies:
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.14.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.14.2
 - !ruby/object:Gem::Dependency
   name: factory_girl_rails
   requirement: !ruby/object:Gem::Requirement
@@ -398,14 +398,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 4.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 4.0.2
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -627,6 +627,7 @@ files:
 - db/migrate/15_add_alt_text_to_bricks.rb
 - db/migrate/16_update_default_value_for_page_type.rb
 - db/migrate/17_set_page_type_to_content_for_empty_fields.rb
+- db/migrate/20140327141200_add_identifier_to_kuhsaft_pages.rb
 - db/seeds.rb
 - lib/generators/kuhsaft/assets/install_generator.rb
 - lib/generators/kuhsaft/translations/add_generator.rb
@@ -637,6 +638,7 @@ files:
 - lib/kuhsaft/page_tree.rb
 - lib/kuhsaft/partial_extractor.rb
 - lib/kuhsaft/searchable.rb
+- lib/kuhsaft/touch_placeholders.rb
 - lib/kuhsaft/translatable.rb
 - lib/kuhsaft/version.rb
 - lib/kuhsaft.rb
@@ -704,6 +706,7 @@ files:
 - spec/lib/image_uploader_mounting_spec.rb
 - spec/lib/page_tree_spec.rb
 - spec/lib/searchable_spec.rb
+- spec/lib/touch_placeholders_spec.rb
 - spec/lib/translatable_spec.rb
 - spec/models/accordion_brick_spec.rb
 - spec/models/accordion_item_brick_spec.rb
@@ -807,6 +810,7 @@ test_files:
 - spec/lib/image_uploader_mounting_spec.rb
 - spec/lib/page_tree_spec.rb
 - spec/lib/searchable_spec.rb
+- spec/lib/touch_placeholders_spec.rb
 - spec/lib/translatable_spec.rb
 - spec/models/accordion_brick_spec.rb
 - spec/models/accordion_item_brick_spec.rb