krant 0.1.0

data/lib/krant/engine.rb

@@ -0,0 +1,14 @@
+require 'active_admin'
+require 'kramdown'
+
+module Krant
+  # Rails integration
+  # @api private
+  class Engine < ::Rails::Engine
+    isolate_namespace Krant
+
+    config.generators do |g|
+      g.test_framework :rspec, fixture: false
+    end
+  end
+end

data/lib/krant/news.rb

@@ -0,0 +1,102 @@
+module Krant
+  # A collection of news items
+  class News
+    # Create a news collection for the given scope.
+    #
+    # @param scope [Module|Class|String] Used to prevent naming
+    # clashes between different news collections, when news item are
+    # persited to the database.
+    def self.about(scope)
+      new(scope: scope.to_s)
+    end
+
+    # @api private
+    def initialize(scope:)
+      @templates = {}
+      @scope = scope
+    end
+
+    # @api private
+    attr_reader :scope
+
+    # Define a new item that will be stored in the database on next
+    # `persist` call. Usually called from an initializer, either in
+    # the main application or a plugin gem.
+    #
+    # @param name [String] Unique name for the item. It is good
+    #   practice to use the name of the library or plugin as a prefix
+    #   and separate different parts of the name with dots. Especially
+    #   when multiple plugin gems define news for a common scope, this
+    #   prevents naming clashes.
+    #
+    # @param [Hash] options
+    #
+    # @option options [Hash] :title A hash with locales as keys and
+    #   short titles that can displayed in a header as values.
+    #
+    # @option options [Hash] :text A hash with locales as keys and
+    #   longer descriptions of the new feature as values. Use Markdown
+    #   to format the text.
+    #
+    # @example Add a news item
+    #   MyApp.news.item('some_plugin.social_share_links',
+    #                   title: {
+    #                     en: 'Social Share Links',
+    #                     de: 'Teilen Links'
+    #                   },
+    #                   text: {
+    #                     en: 'Now displays links to [Twitter](http://twitter.com).'
+    #                     en: 'Zeigt nun Links zu [Twitter](http://twitter.com).'
+    #                   })
+    #
+    def item(name, attributes)
+      @templates[name.to_s] = attributes
+    end
+
+    # @api private
+    def persist
+      @templates.each do |name, template|
+        NewsItem.find_or_create_by(scope: @scope, name: name) do |news_item|
+          if block_given?
+            news_item.template = template
+            yield news_item
+          end
+        end
+      end
+    end
+
+    # @api private
+    def all(for_user:)
+      last_seen_at = last_seen(for_user)
+
+      persisted_items.order('created_at desc').select do |news_item|
+        news_item.seen = last_seen_at && news_item.created_at <= last_seen_at
+        news_item.template = @templates[news_item.name]
+      end
+    end
+
+    # @api private
+    def unseen_items?(for_user:)
+      last_seen_at = last_seen(for_user)
+
+      scope = persisted_items
+      scope = scope.where('created_at > ?', last_seen_at) if last_seen_at
+      scope.exists?
+    end
+
+    # @api private
+    def seen_by!(user)
+      LastSeenState.find_or_create_by(scope: @scope, user: user).touch
+    end
+
+    private
+
+    def persisted_items
+      NewsItem.where(scope: @scope)
+    end
+
+    def last_seen(user)
+      LastSeenState.where(scope: @scope, user: user).first.try(:updated_at)
+    end
+  end
+end

data/lib/krant/tasks.rb

@@ -0,0 +1,26 @@
+require 'rake'
+
+module Krant
+  # Create database records for each new news item. Together with
+  # the "last seen" timestamp of a user, the corresponding creation
+  # timestamps will be used to determine seen/unseen state of each
+  # news item.
+  module Tasks
+    extend Rake::DSL
+
+    # Defines a news:persist task that persists news items to the
+    # database.
+    #
+    # @param news [Krant::News] Collection to read items from.
+    def self.install(&block)
+      desc 'Persist news items'
+      task 'news:persist' => 'environment' do
+        news = block.call
+        puts "Persisting news for #{news.scope}..."
+        news.persist do |news_item|
+          puts "- #{news_item.name}: #{news_item.title}"
+        end
+      end
+    end
+  end
+end

data/lib/krant/version.rb

@@ -0,0 +1,3 @@
+module Krant
+  VERSION = '0.1.0'.freeze
+end

data/lib/krant/views/header_with_broadcast_messages.rb

@@ -0,0 +1,20 @@
+module Krant
+  module Views
+    # Extends the normal Active Admin header to include broadcast
+    # messages.
+    class HeaderWithBroadcastMessages < Arbre::Component
+      builder_method :krant_header_with_broadcast_messages
+
+      def build(*args)
+        insert_tag(ActiveAdmin::Views::Header, *args)
+        div do
+          TranslatedBroadcastMessage.active.each do |broadcast_message|
+            div class: 'krant-broadcast-messages-bar' do
+              broadcast_message.text
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/krant/views/news_list.rb

@@ -0,0 +1,36 @@
+module Krant
+  module Views
+    # A list of recent news. Rendering the component marks news as
+    # seen.
+    class NewsList < Arbre::Component
+      builder_method :krant_news_list
+
+      # @param news [Krant::News] News collection to take news from.
+      def build(news)
+        super(class: 'krant-news-list')
+
+        news.all(for_user: current_active_admin_user).each do |news_item|
+          item(news_item)
+        end
+
+        script raw('jQuery.post(location.pathname + "/seen")')
+      end
+
+      private
+
+      def item(news_item)
+        div class: item_css_class(news_item) do
+          h3 news_item.title
+          text_node Kramdown::Document.new(news_item.text).to_html.html_safe
+        end
+      end
+
+      def item_css_class(news_item)
+        [
+          'krant-news-list-item',
+          news_item.seen? ? 'krant-news-list-item-seen' : 'krant-news-list-item-unseen'
+        ].compact.join(' ')
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,281 @@
+--- !ruby/object:Gem::Specification
+name: krant
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tim Fischbach
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-12-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: combustion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.15'
+- !ruby/object:Gem::Dependency
+  name: factory_bot_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.8'
+- !ruby/object:Gem::Dependency
+  name: domino
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: semmy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+- !ruby/object:Gem::Dependency
+  name: activeadmin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.x
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.x
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+description: 
+email:
+- tfischbach@codevise.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Appraisals
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- admin/krant/broadcast_messages.rb
+- app/assets/stylesheets/krant/active_admin.scss
+- app/assets/stylesheets/krant/active_admin/broadcast_messages.scss
+- app/assets/stylesheets/krant/active_admin/news_list.scss
+- app/models/krant/broadcast_message.rb
+- app/models/krant/broadcast_message_translation.rb
+- app/models/krant/last_seen_state.rb
+- app/models/krant/news_item.rb
+- app/models/krant/translated_broadcast_message.rb
+- bin/console
+- bin/rails
+- bin/rspec
+- bin/setup
+- config/locales/de.yml
+- config/locales/en.yml
+- db/migrate/20171214095614_create_krant_broadcast_messages.rb
+- db/migrate/20171214095622_create_krant_broadcast_message_translations.rb
+- db/migrate/20171214175840_create_krant_news_items.rb
+- db/migrate/20171215080737_create_krant_last_seen_states.rb
+- gemfiles/rails_4.2_active_admin_1.0.0.pre4.gemfile
+- gemfiles/rails_4.2_active_admin_1.0.gemfile
+- gemfiles/rails_4.2_active_admin_1.1.gemfile
+- krant.gemspec
+- lib/krant.rb
+- lib/krant/engine.rb
+- lib/krant/news.rb
+- lib/krant/tasks.rb
+- lib/krant/version.rb
+- lib/krant/views/header_with_broadcast_messages.rb
+- lib/krant/views/news_list.rb
+homepage: https://github.com/codevise/krant
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.0
+signing_key: 
+specification_version: 4
+summary: Display app news and broadcast messages in Active Admin.
+test_files: []