krant 0.1.0

data/app/assets/stylesheets/krant/active_admin.scss

@@ -0,0 +1,2 @@
+@import "./active_admin/broadcast_messages";
+@import "./active_admin/news_list";

data/app/assets/stylesheets/krant/active_admin/broadcast_messages.scss

@@ -0,0 +1,31 @@
+$krant-broadcast-message-bar-color: #f6efce !default;
+$krant-broadcast-message-bar-border-color: #dedede !default;
+
+.krant-broadcast-messages {
+  &-table-text {
+    white-space: nowrap;
+
+    &-locale,
+    &-translation {
+      display: inline-block;
+    }
+
+    &-locale {
+      font-weight: bold;
+      min-width: 2em;
+    }
+
+    &-translation {
+      vertical-align: top;
+      white-space: normal;
+    }
+  }
+
+  &-bar {
+    background-color: $krant-broadcast-message-bar-color;
+    border-left: solid 1px $krant-broadcast-message-bar-border-color;
+    border-right: solid 1px $krant-broadcast-message-bar-border-color;
+    padding: 10px $horizontal-page-margin;
+    text-align: center;
+  }
+}

data/app/assets/stylesheets/krant/active_admin/news_list.scss

@@ -0,0 +1,19 @@
+$krant-news-list-item-marker-color: #eee !default;
+$krant-unseen-news-list-item-marker-color: #63a0e8 !default;
+$krant-unseen-news-list-item-marker-width: 2px !default;
+$krant-unseen-news-list-item-padding: 1em !default;
+$krant-unseen-news-list-item-background-color: #eee !default;
+
+.krant-news-list {
+  margin-left: -$krant-unseen-news-list-item-marker-width;
+}
+
+.krant-news-list-item {
+  border-left: solid $krant-unseen-news-list-item-marker-width $krant-news-list-item-marker-color;
+  margin-left: -$krant-unseen-news-list-item-padding;
+  padding: 0 $krant-unseen-news-list-item-padding;
+
+  &-unseen {
+    border-left: solid $krant-unseen-news-list-item-marker-width $krant-unseen-news-list-item-marker-color;
+  }
+}

data/app/models/krant/broadcast_message.rb

@@ -0,0 +1,10 @@
+module Krant
+  # @api private
+  class BroadcastMessage < ActiveRecord::Base
+    has_many(:translations, class_name: 'BroadcastMessageTranslation')
+
+    accepts_nested_attributes_for(:translations)
+
+    scope(:active, -> { where(active: true) })
+  end
+end

data/app/models/krant/broadcast_message_translation.rb

@@ -0,0 +1,6 @@
+module Krant
+  # @api private
+  class BroadcastMessageTranslation < ActiveRecord::Base
+    belongs_to :broadcast_message
+  end
+end

data/app/models/krant/last_seen_state.rb

@@ -0,0 +1,6 @@
+module Krant
+  # @api private
+  class LastSeenState < ActiveRecord::Base
+    belongs_to :user, polymorphic: true
+  end
+end

data/app/models/krant/news_item.rb

@@ -0,0 +1,35 @@
+module Krant
+  # @api private
+  class NewsItem < ActiveRecord::Base
+    attr_accessor :template
+    attr_accessor :seen
+
+    def title
+      translated_attribute('title')
+    end
+
+    def text
+      translated_attribute('text')
+    end
+
+    def unseen?
+      !seen
+    end
+
+    def seen?
+      seen
+    end
+
+    private
+
+    def translated_attribute(name)
+      attribute_translations(name).fetch(I18n.locale.to_sym) do
+        attribute_translations(name).fetch(I18n.default_locale.to_sym, '')
+      end
+    end
+
+    def attribute_translations(name)
+      template.fetch(name.to_sym, {})
+    end
+  end
+end

data/app/models/krant/translated_broadcast_message.rb

@@ -0,0 +1,47 @@
+module Krant
+  # @api private
+  class TranslatedBroadcastMessage
+    attr_reader :text
+
+    def initialize(text)
+      @text = text
+    end
+
+    def self.active
+      Query.new.active
+    end
+
+    # @api private
+    class Query
+      def active
+        scope = BroadcastMessage.active
+
+        scope = with_translation(scope, 'current_locale', I18n.locale)
+        scope = with_translation(scope, 'default_locale', I18n.default_locale)
+
+        scope.map do |broadcast_message|
+          TranslatedBroadcastMessage.new(broadcast_message.current_locale_text.presence ||
+                                         broadcast_message.default_locale_text)
+        end
+      end
+
+      private
+
+      def with_translation(scope, name, locale)
+        table_alias = "#{name}_translations"
+
+        scope
+          .select("#{table_alias}.text as #{name}_text")
+          .joins(sanitize_sql(<<-SQL, locale))
+            LEFT JOIN krant_broadcast_message_translations #{table_alias}
+            ON #{table_alias}.broadcast_message_id = krant_broadcast_messages.id AND
+               #{table_alias}.locale = ?
+        SQL
+      end
+
+      def sanitize_sql(sql, interpolations)
+        ActiveRecord::Base.send(:sanitize_sql_array, [sql, interpolations])
+      end
+    end
+  end
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "krant"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/rails

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 4 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/krant/engine', __FILE__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails/all'
+require 'rails/engine/commands'

data/bin/rspec

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config/locales/de.yml

@@ -0,0 +1,23 @@
+de:
+  krant:
+    admin:
+      broadcast_messages:
+        text_translation_label: "Text (%{locale_name}):"
+      news_menu_item:
+        unseen: "Neuigkeiten*"
+        no_unseen: "Neuigkeiten"
+  activerecord:
+    models:
+      # Required for ActiveAdmin navigation
+      broadcast_message:
+        one: "Broadcast Nachricht"
+        other: "Broadcast Nachrichten"
+      "krant/broadcast_message":
+        one: "Broadcast Nachricht"
+        other: "Broadcast Nachrichten"
+    attributes:
+      "krant/broadcast_message":
+        text: "Text"
+        active: "Aktiv"
+        created_at: "Erstellt am"
+        updated_at: "Geändert am"

data/config/locales/en.yml

@@ -0,0 +1,23 @@
+en:
+  krant:
+    admin:
+      broadcast_messages:
+        text_translation_label: "Text (%{locale_name}):"
+      news_menu_item:
+        unseen: "What's new*"
+        no_unseen: "What's new"
+  activerecord:
+    models:
+      # Required for ActiveAdmin navigation
+      broadcast_message:
+        one: "Broadcast Message"
+        other: "Broadcast Messages"
+      "krant/broadcast_message":
+        one: "Broadcast Message"
+        other: "Broadcast Messages"
+    attributes:
+      "krant/broadcast_message":
+        text: "Text"
+        active: "Active"
+        created_at: "Created at"
+        updated_at: "Updated at"

data/db/migrate/20171214095614_create_krant_broadcast_messages.rb

@@ -0,0 +1,9 @@
+class CreateKrantBroadcastMessages < ActiveRecord::Migration
+  def change
+    create_table :krant_broadcast_messages do |t|
+      t.boolean :active
+
+      t.timestamps null: false
+    end
+  end
+end

data/db/migrate/20171214095622_create_krant_broadcast_message_translations.rb

@@ -0,0 +1,12 @@
+class CreateKrantBroadcastMessageTranslations < ActiveRecord::Migration
+  def change
+    create_table :krant_broadcast_message_translations do |t|
+      t.belongs_to(:broadcast_message,
+                   index: { name: 'index_krant_broadcast_message_translations_on_message_id' })
+      t.string :locale
+      t.text :text
+
+      t.timestamps null: false
+    end
+  end
+end

data/db/migrate/20171214175840_create_krant_news_items.rb

@@ -0,0 +1,10 @@
+class CreateKrantNewsItems < ActiveRecord::Migration
+  def change
+    create_table :krant_news_items do |t|
+      t.string :scope
+      t.string :name
+
+      t.timestamps null: false
+    end
+  end
+end

data/db/migrate/20171215080737_create_krant_last_seen_states.rb

@@ -0,0 +1,10 @@
+class CreateKrantLastSeenStates < ActiveRecord::Migration
+  def change
+    create_table :krant_last_seen_states do |t|
+      t.string :scope
+      t.belongs_to :user, index: true, polymorphic: true
+
+      t.timestamps null: false
+    end
+  end
+end

data/gemfiles/rails_4.2_active_admin_1.0.0.pre4.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 4.2"
+gem "activeadmin", "1.0.0.pre4"
+
+gemspec path: "../"

data/gemfiles/rails_4.2_active_admin_1.0.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 4.2"
+gem "activeadmin", "~> 1.0"
+
+gemspec path: "../"

data/gemfiles/rails_4.2_active_admin_1.1.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 4.2"
+gem "activeadmin", "~> 1.1"
+
+gemspec path: "../"

data/krant.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'krant/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'krant'
+  spec.version       = Krant::VERSION
+  spec.authors       = ['Tim Fischbach']
+  spec.email         = ['tfischbach@codevise.de']
+
+  spec.summary       = 'Display app news and broadcast messages in Active Admin.'
+  spec.homepage      = 'https://github.com/codevise/krant'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '~> 2.1'
+
+  spec.add_development_dependency 'appraisal', '~> 2.2'
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec-rails', '~> 3.6'
+  spec.add_development_dependency 'combustion', '~> 0.7.0'
+  spec.add_development_dependency 'sqlite3', '~> 1.3'
+  spec.add_development_dependency 'capybara', '~> 2.15'
+  spec.add_development_dependency 'factory_bot_rails', '~> 4.8'
+  spec.add_development_dependency 'domino', '~> 0.7.0'
+  spec.add_development_dependency 'semmy', '~> 1.0'
+  spec.add_development_dependency 'timecop', '~> 0.7.1'
+
+  spec.add_runtime_dependency 'activeadmin', '~> 1.x'
+  spec.add_runtime_dependency 'rails', '~> 4.2'
+  spec.add_runtime_dependency 'kramdown', '~> 1.5'
+end

data/lib/krant.rb

@@ -0,0 +1,57 @@
+require 'krant/engine'
+require 'krant/news'
+require 'krant/version'
+require 'krant/views/header_with_broadcast_messages'
+require 'krant/views/news_list'
+
+# Global settings
+module Krant
+  # Determines for which locales text boxes should be displayed in the
+  # broadcast message edit form.
+  mattr_accessor :broadcast_message_locales
+  self.broadcast_message_locales = [:en, :de]
+
+  # Unshift to Active Admin load path.
+  def self.active_admin_load_path
+    Dir[Krant::Engine.root.join('admin')].first
+  end
+
+  # Adds a menu item to open a news page. Displays an indicator if
+  # there are unseen news items. Supports all parameters supported by
+  # `ActiveAdmin::Menu#add`. Required options:
+  #
+  # @param menu [ActiveAdmin::Menu] The menu object yielded by
+  #   `ActiveAdmin::Namespace#build_menu`.
+  #
+  # @param news [Krant::News] The news collection to take news item
+  #   from.
+  #
+  # @param url [Proc|String] Url of the news page.
+  def self.add_active_admin_news_menu_item_to(menu, news:, **options)
+    menu.add(label: -> { I18n.t('krant.admin.news_menu_item.unseen') },
+             id: 'krant_news_menu_item_unseen',
+             if: -> { news.unseen_items?(for_user: current_active_admin_user) },
+             html_options: { class: 'krant-news-menu-item krant-news-menu-item-unseen' },
+             **options)
+
+    menu.add(label: -> { I18n.t('krant.admin.news_menu_item.no_unseen') },
+             id: 'krant_news_menu_item_no_unseen',
+             if: -> { !news.unseen_items?(for_user: current_active_admin_user) },
+             html_options: { class: 'krant-news-menu-item krant-news-menu-item-no-unseen' },
+             **options)
+  end
+
+  # Apply default settings to news page.
+  #
+  # @param page [ActiveAdmin::PageDSL] The admin page.
+  #
+  # @param news [Proc] Proc returing the news collection.
+  def self.active_admin_news_page(page, news:)
+    page.menu(false)
+
+    page.page_action(:seen, method: [:post]) do
+      news.call.seen_by!(current_active_admin_user)
+      render text: ''
+    end
+  end
+end