spree_posts 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c7201669bde6f132f7a639b35712d2cb84fef08d14d683cffb1475d080b710b3
+  data.tar.gz: 27b670664530c0f01c555cfe6f337492c114b1c2d043742907aa3c23ccfd5b31
+SHA512:
+  metadata.gz: f94ad0b4715aa0d9bbbf2952d5e333a3483739f715afcdefbff12dc05ac7535eb15bd0a3ceeaea4dfc2a4f04d3fd2a17a1712f0b828cfb431b3deae98a8ddf45
+  data.tar.gz: 0a059bd209b396729481e427c275ed2cc95c81d527161970e824ae694d215de95709035e696e2e1c1cc1d93208b1aafc8d6a4ee33fb72287427f3853c4074ea9

data/LICENSE.md

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2026 Vendo Connect Inc., Vendo Sp. z o.o.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,59 @@
+# Spree Posts
+
+This is a Posts extension for [Spree Commerce](https://spreecommerce.org)
+
+## Installation
+
+1. Add this extension to your Gemfile with this line:
+
+    ```ruby
+    bundle add spree_posts
+    ```
+
+2. Run the install generator
+
+    ```ruby
+    bundle exec rails g spree_posts:install
+    ```
+
+3. Restart your server
+
+  If your server was running, restart it so that it can find the assets properly.
+
+## Developing
+
+1. Create a dummy app
+
+    ```bash
+    bundle update
+    bundle exec rake test_app
+    ```
+
+2. Add your new code
+3. Run tests
+
+    ```bash
+    bundle exec rspec
+    ```
+
+When testing your applications integration with this extension you may use it's factories.
+Simply add this require statement to your spec_helper:
+
+```ruby
+require 'spree_posts/factories'
+```
+
+## Releasing a new version
+
+```shell
+bundle exec gem bump -p -t
+bundle exec gem release
+```
+
+For more options please see [gem-release README](https://github.com/svenfuchs/gem-release)
+
+## Contributing
+
+If you'd like to contribute, please take a look at the
+[instructions](CONTRIBUTING.md) for installing dependencies and crafting a good
+pull request.

data/Rakefile

@@ -0,0 +1,23 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+require 'spree/testing_support/extension_rake'
+
+RSpec::Core::RakeTask.new
+
+task :default do
+  if Dir['spec/dummy'].empty?
+    Rake::Task[:test_app].invoke
+    Dir.chdir('../../')
+  end
+  Rake::Task[:spec].invoke
+end
+
+desc 'Generates a dummy app for testing'
+task :test_app do
+  ENV['LIB_NAME'] = 'spree_posts'
+  Rake::Task['extension:test_app'].execute(
+    install_admin: true
+  )
+end

data/app/controllers/spree/admin/post_categories_controller.rb

@@ -0,0 +1,21 @@
+module Spree
+  module Admin
+    class PostCategoriesController < ResourceController
+      include Spree::Admin::TableConcern
+
+      add_breadcrumb Spree.t(:posts), :admin_posts_path
+      add_breadcrumb Spree.t(:categories), :admin_post_categories_path
+
+      def select_options
+        post_categories = current_store.post_categories.accessible_by(current_ability)
+        render json: post_categories.pluck(:id, :title).map { |id, title| { id: id, name: title } }
+      end
+
+      private
+
+      def permitted_resource_params
+        params.require(:post_category).permit(:title, :slug, :description)
+      end
+    end
+  end
+end

data/app/controllers/spree/admin/posts_controller.rb

@@ -0,0 +1,41 @@
+module Spree
+  module Admin
+    class PostsController < ResourceController
+      include Spree::Admin::TableConcern
+
+      before_action :load_post_categories
+
+      add_breadcrumb Spree.t(:posts), :admin_posts_path
+
+      before_action :add_breadcrumb_for_post, only: [:edit, :update]
+
+      def select_options
+        render json: current_store.posts.published.accessible_by(current_ability).to_tom_select_json
+      end
+
+      private
+
+      def collection_includes
+        [:author, :post_category, :image_attachment]
+      end
+
+      def load_post_categories
+        @post_categories = current_store.post_categories.accessible_by(current_ability).order(:title)
+      end
+
+      def add_breadcrumb_for_post
+        return unless @post.present?
+
+        add_breadcrumb @post.title, spree.edit_admin_post_path(@post)
+      end
+
+      def permitted_resource_params
+        params.require(:post).permit(
+          :title, :meta_title, :meta_description, :slug, :author_id,
+          :post_category_id, :published_at, :content, :excerpt, :image,
+          tag_list: []
+        )
+      end
+    end
+  end
+end

data/app/finders/spree/posts/find.rb

@@ -0,0 +1,137 @@
+module Spree
+  module Posts
+    class Find < Spree::BaseFinder
+      def initialize(scope:, params:)
+        super(scope: scope, params: params)
+        @scope = scope
+        @query = params[:q].presence&.strip
+        @ids = String(params.dig(:filter, :ids)).split(',')
+        @slugs = String(params.dig(:filter, :slugs)).split(',')
+        @category_ids = String(params.dig(:filter, :category_ids)).split(',')
+        @author_ids = String(params.dig(:filter, :author_ids)).split(',')
+        @tags = params.dig(:filter, :tags).to_s.split(',').compact_blank
+        @sort_by = params[:sort_by]
+        @published = params.dig(:filter, :published)
+      end
+
+      def execute
+        posts = by_ids(scope)
+        posts = by_slugs(posts)
+        posts = by_query(posts)
+        posts = by_category_ids(posts)
+        posts = by_author_ids(posts)
+        posts = by_tags(posts)
+        posts = by_published(posts)
+        posts = ordered(posts)
+
+        posts.distinct
+      end
+
+      private
+
+      attr_reader :scope, :query, :ids, :slugs, :category_ids, :author_ids, :tags, :sort_by, :published
+
+      def query?
+        query.present?
+      end
+
+      def ids?
+        ids.present?
+      end
+
+      def slugs?
+        slugs.present?
+      end
+
+      def category_ids?
+        category_ids.present?
+      end
+
+      def author_ids?
+        author_ids.present?
+      end
+
+      def tags?
+        tags.present?
+      end
+
+      def published?
+        published.present?
+      end
+
+      def sort_by?
+        sort_by.present?
+      end
+
+      def by_query(posts)
+        return posts unless query?
+
+        posts.search_by_title(query)
+      end
+
+      def by_ids(posts)
+        return posts unless ids?
+
+        posts.where(id: ids)
+      end
+
+      def by_slugs(posts)
+        return posts unless slugs?
+
+        posts.where(slug: slugs)
+      end
+
+      def by_category_ids(posts)
+        return posts unless category_ids?
+
+        posts.where(post_category_id: category_ids)
+      end
+
+      def by_author_ids(posts)
+        return posts unless author_ids?
+
+        posts.where(author_id: author_ids)
+      end
+
+      def by_tags(posts)
+        return posts if tags.empty?
+
+        posts.tagged_with(tags, any: true)
+      end
+
+      def by_published(posts)
+        return posts unless published?
+
+        case published.to_s
+        when 'true'
+          posts.published
+        when 'false'
+          posts.where(published_at: nil)
+        else
+          posts
+        end
+      end
+
+      def ordered(posts)
+        return posts unless sort_by?
+
+        case sort_by
+        when 'newest-first'
+          posts.by_newest
+        when 'oldest-first'
+          posts.order(created_at: :asc)
+        when 'published-newest'
+          posts.order(published_at: :desc)
+        when 'published-oldest'
+          posts.order(published_at: :asc)
+        when 'title-a-z'
+          posts.order(title: :asc)
+        when 'title-z-a'
+          posts.order(title: :desc)
+        else
+          posts
+        end
+      end
+    end
+  end
+end

data/app/helpers/spree/admin/posts_helper.rb

@@ -0,0 +1,13 @@
+module Spree
+  module Admin
+    module PostsHelper
+      def post_authors_select_options
+        current_store.users.map { |user| [user.name, user.id] }
+      end
+
+      def post_tags_json_array
+        Spree::Post.all_tags.map { |tag| { name: tag.name } }.to_json
+      end
+    end
+  end
+end

data/app/models/spree/post.rb

@@ -0,0 +1,108 @@
+module Spree
+  class Post < Spree.base_class
+    has_prefix_id :post
+
+    include Spree::SingleStoreResource
+    include Spree::Metafields
+    extend FriendlyId
+
+    publishes_lifecycle_events
+
+    friendly_id :slug_candidates, use: %i[slugged scoped history], scope: %i[store_id deleted?]
+    acts_as_paranoid
+    acts_as_taggable_on :tags
+    acts_as_taggable_tenant :store_id
+
+    if defined?(PgSearch)
+      include PgSearch::Model
+      pg_search_scope :search_by_title, against: :title
+    else
+      scope :search_by_title, ->(query) { where('title LIKE ?', "%#{query}%") }
+    end
+
+    #
+    # Ransack filtering
+    #
+    self.whitelisted_ransackable_attributes = %w[author_id post_category_id published_at]
+    self.whitelisted_ransackable_associations = %w[author post_category]
+    self.whitelisted_ransackable_scopes = %w[search_by_title]
+
+    #
+    # Attachments
+    #
+    has_one_attached :image, service: Spree.public_storage_service_name
+
+    #
+    # Rich Text
+    #
+    has_rich_text :content
+    has_rich_text :excerpt
+
+    #
+    # Associations
+    #
+    belongs_to :author, class_name: Spree.admin_user_class.to_s, optional: true
+    belongs_to :store, class_name: 'Spree::Store', inverse_of: :posts
+    belongs_to :post_category, class_name: 'Spree::PostCategory', optional: true, touch: true, inverse_of: :posts
+    alias category post_category
+
+    #
+    # Validations
+    #
+    validates :title, :store, presence: true
+    validates :slug, presence: true, uniqueness: { scope: :store_id, conditions: -> { where(deleted_at: nil) } }
+    validates :meta_title, length: { maximum: 160 }, allow_blank: true
+    validates :meta_description, length: { maximum: 320 }, allow_blank: true
+    validates :image, content_type: Rails.application.config.active_storage.web_image_content_types
+
+    #
+    # Scopes
+    #
+    scope :published, -> { where(published_at: [..Time.current]) }
+    scope :by_newest, -> { order(created_at: :desc) }
+
+    delegate :name, to: :author, prefix: true, allow_nil: true
+    delegate :title, to: :post_category, prefix: true, allow_nil: true
+
+    def should_generate_new_friendly_id?
+      slug.blank? || (persisted? && title_changed?)
+    end
+
+    def slug_candidates
+      [
+        :title,
+        [:title, :id]
+      ]
+    end
+
+    def published?
+      published_at.present?
+    end
+
+    def publish(date = nil)
+      update(published_at: date || Time.current)
+    end
+
+    def unpublish
+      update(published_at: nil)
+    end
+
+    def description
+      excerpt.to_plain_text.presence || content.to_plain_text
+    end
+
+    def shortened_description
+      desc = excerpt.to_plain_text.presence || content.to_plain_text
+      desc.length > 320 ? "#{desc[0...320]}..." : desc
+    end
+
+    def self.to_tom_select_json
+      pluck(:id, :title).map do |id, title|
+        {
+          id: id,
+          name: title
+        }
+      end.as_json
+    end
+  end
+end

data/app/models/spree/post_category.rb

@@ -0,0 +1,46 @@
+module Spree
+  class PostCategory < Spree.base_class
+    has_prefix_id :pcat
+
+    include Spree::SingleStoreResource
+    include Spree::Metafields
+    extend FriendlyId
+
+    publishes_lifecycle_events
+
+    friendly_id :slug_candidates, use: %i[slugged scoped history], scope: %i[store_id]
+
+    #
+    # Associations
+    #
+    belongs_to :store, class_name: 'Spree::Store', inverse_of: :post_categories
+    has_many :posts, class_name: 'Spree::Post', dependent: :nullify, inverse_of: :post_category
+
+    #
+    # Validations
+    #
+    validates :title, :store, presence: true
+    validates :slug, presence: true, uniqueness: { scope: :store_id }
+
+    #
+    # ActionText
+    #
+    has_rich_text :description
+
+    #
+    # Ransack
+    #
+    self.whitelisted_ransackable_attributes = %w[title slug]
+
+    def should_generate_new_friendly_id?
+      slug.blank? || title_changed?
+    end
+
+    def slug_candidates
+      [
+        :title,
+        [:title, :id]
+      ]
+    end
+  end
+end

data/app/models/spree/store_decorator.rb

@@ -0,0 +1,28 @@
+module Spree
+  module StoreDecorator
+    def self.prepended(base)
+      base.has_many :posts, class_name: 'Spree::Post', dependent: :destroy, inverse_of: :store
+      base.has_many :post_categories, class_name: 'Spree::PostCategory', dependent: :destroy, inverse_of: :store
+
+      base.after_create :ensure_default_post_categories_are_created
+    end
+
+    private
+
+    def ensure_default_post_categories_are_created
+      Spree::Events.disable do
+        [
+          I18n.t('spree.default_post_categories.resources', default: 'Resources'),
+          I18n.t('spree.default_post_categories.articles', default: 'Articles'),
+          I18n.t('spree.default_post_categories.news', default: 'News')
+        ].each do |category_title|
+          next if post_categories.where(title: category_title).exists?
+
+          post_categories.create(title: category_title)
+        end
+      end
+    end
+  end
+end
+
+Spree::Store.prepend(Spree::StoreDecorator)

data/app/sorters/spree/posts/sort.rb

@@ -0,0 +1,40 @@
+module Spree
+  module Posts
+    class Sort < ::Spree::BaseSorter
+      def initialize(scope, params = {}, allowed_sort_attributes = [])
+        super(scope, params, allowed_sort_attributes)
+      end
+
+      def call
+        posts = by_param_attributes(scope)
+        posts = select_translatable_fields(posts) if Spree.use_translations?
+
+        posts.distinct
+      end
+
+      private
+
+      attr_reader :sort, :scope, :allowed_sort_attributes
+
+      # Add translatable fields to SELECT statement to avoid InvalidColumnReference error (workaround for Mobility issue #596)
+      def select_translatable_fields(scope)
+        translatable_fields = translatable_sortable_fields
+        return scope if translatable_fields.empty?
+
+        scope.i18n.select("#{Spree::Post.table_name}.*").select(*translatable_fields)
+      end
+
+      def translatable_sortable_fields
+        fields = []
+        Spree::Post.translatable_fields.each do |field|
+          fields << field if sort_by?(field.to_s)
+        end
+        fields
+      end
+
+      def sort_by?(field)
+        sort.detect { |s| s[0] == field }
+      end
+    end
+  end
+end

data/app/views/spree/admin/post_categories/_form.html.erb

@@ -0,0 +1,6 @@
+<div class="card mb-6">
+  <div class="card-body">
+    <%= f.spree_text_field :title, required: true, autofocus: f.object.new_record? %>
+    <%= f.spree_rich_text_area :description %>
+  </div>
+</div>

data/app/views/spree/admin/post_categories/_table_header.html.erb

@@ -0,0 +1,5 @@
+<tr>
+  <th scope="col"><%= Spree.t(:title) %></th>
+  <th scope="col"><%= Spree.t(:posts) %></th>
+  <th scope="col"></th>
+</tr>

data/app/views/spree/admin/post_categories/_table_row.html.erb

@@ -0,0 +1,9 @@
+<tr data-controller="row-link" id="<%= dom_id(post_category) %>">
+  <td class="w-60 p-0">
+    <%= link_to post_category.title, spree.edit_admin_post_category_path(post_category), class: 'block w-full h-full px-4 py-2', data: { row_link_target: :link, turbo_frame: '_top' } %>
+  </td>
+  <td class="w-10 cursor-pointer" data-action="click->row-link#openLink"><%= post_category.posts.count %></td>
+  <td class="w-10 cursor-pointer text-right" data-action="click->row-link#openLink">
+    <%= link_to_edit(post_category, class: 'btn btn-light btn-sm', data: { turbo_frame: '_top' }) if can? :edit, post_category %>
+  </td>
+</tr>

data/app/views/spree/admin/post_categories/edit.html.erb

@@ -0,0 +1 @@
+<%= render 'spree/admin/shared/edit_resource' %>

data/app/views/spree/admin/post_categories/index.html.erb

@@ -0,0 +1,10 @@
+<%= render 'spree/admin/shared/posts_tabs' %>
+
+<% content_for :page_actions do %>
+  <%= render_admin_partials(:post_categories_actions_partials) %>
+  <%= link_to_with_icon 'plus', Spree.t(:new_post_category), new_object_url, class: 'btn btn-primary' if can?(:create, Spree::PostCategory) %>
+<% end %>
+
+<%= render_admin_partials(:post_categories_header_partials) %>
+
+<%= render_table @collection, :post_categories %>

data/app/views/spree/admin/post_categories/new.html.erb

@@ -0,0 +1 @@
+<%= render 'spree/admin/shared/new_resource' %>

data/app/views/spree/admin/posts/_extra_actions.html.erb

@@ -0,0 +1 @@
+

data/app/views/spree/admin/posts/_form.html.erb

@@ -0,0 +1,54 @@
+<div class="grid grid-cols-12 gap-6" data-controller="slug-form seo-form">
+  <div class="col-span-12 lg:col-span-8">
+    <div class="card mb-6">
+      <div class="card-body">
+        <%= f.spree_text_field :title,
+              required: true,
+              autofocus: true,
+              data: {
+                seo_form_target: 'sourceTitleInput',
+                slug_form_target: 'name',
+                action: 'slug-form#updateUrlFromName'
+              } %>
+
+        <%= f.spree_rich_text_area :content,
+              help_bubble: 'Add a summary of the post',
+              data: { seo_form_target: 'sourceDescriptionInput' } %>
+
+        <%= f.spree_rich_text_area :excerpt,
+              help_bubble: 'Add a summary of the post',
+              data: { seo_form_target: 'sourceExcerptInput' } %>
+      </div>
+    </div>
+  </div>
+
+  <div class="col-span-12 lg:col-span-4">
+    <div class="card mb-6">
+      <div class="card-body">
+        <%= f.spree_file_field :image, width: 1200, height: 600, crop: true, css: 'flex-col', label: Spree.t(:featured_image) %>
+      </div>
+    </div>
+
+    <div class="card mb-6">
+      <div class="card-body">
+        <%= f.spree_select :author_id, options_for_select(post_authors_select_options, @post.author_id || try_spree_current_user.id), { label: Spree.t(:author), autocomplete: true } %>
+        <%= f.spree_select :post_category_id, options_for_select(@post_categories.pluck(:title, :id), @post.post_category_id), { label: Spree.t(:category), include_blank: true, autocomplete: true } %>
+        <%= f.spree_datetime_field :published_at, help_bubble: 'Marks when the post will be published, leave it blank to hide it' %>
+
+        <div class="form-group mb-0">
+          <%= f.label :tag_list, Spree.t(:tags) %>
+          <%= tom_select_tag 'post[tag_list]', multiple: true, class: 'w-full', options: post_tags_json_array, active_option: @post.tag_list, value_field: :name, create: true %>
+        </div>
+      </div>
+    </div>
+
+    <%= render 'spree/admin/shared/seo',
+          f: f,
+          title: @post.title,
+          meta_title: @post.meta_title,
+          description: @post.content,
+          slug: @post.slug,
+          slug_path: 'posts',
+          placeholder: 'Add a title and content to see how this post might appear in a search engine listing' %>
+  </div>
+</div>

data/app/views/spree/admin/posts/_table_header.html.erb

@@ -0,0 +1,7 @@
+<tr>
+  <th scope="col"><%= sort_link @search, :title, Spree.t(:title) %></th>
+  <th scope="col"><%= Spree.t(:category) %></th>
+  <th scope="col"><%= Spree.t(:author) %></th>
+  <th scope="col"><%= sort_link @search, :published_at, Spree.t(:published_at) %></th>
+  <th scope="col"></th>
+</tr>

data/app/views/spree/admin/posts/_table_row.html.erb

@@ -0,0 +1,22 @@
+<tr data-controller="row-link" id="<%= dom_id(post) %>">
+  <td>
+    <%= link_to spree.edit_admin_post_path(post), class: 'no-underline flex items-center font-bold text-gray-900 gap-4', data: { row_link_target: :link, 'turbo-frame': '_top' } do %>
+      <% if post.image.attached? && post.image.variable? %>
+        <div class="admin-product-image-container">
+          <%= spree_image_tag(post.image, width: 100, height: 65, class: 'img-fluid', loading: :lazy) %>
+        </div>
+      <% else %>
+        <%= render 'spree/admin/shared/no_image', width: 100, height: 65 %>
+      <% end %>
+      <%= post.title %>
+    <% end %>
+  </td>
+
+  <td class="cursor-pointer" data-action="click->row-link#openLink"><%= post.post_category_title || '-' %></td>
+  <td class="cursor-pointer" data-action="click->row-link#openLink"><%= post.author_name %></td>
+  <td class="cursor-pointer" data-action="click->row-link#openLink"><%= post.published_at.present? ? spree_date(post.published_at) : '-' %></td>
+
+  <td class="actions">
+    <%= link_to_edit(post, class: 'btn btn-light btn-sm', data: { 'turbo-frame': '_top' }) if can? :edit, post %>
+  </td>
+</tr>

data/app/views/spree/admin/posts/edit.html.erb

@@ -0,0 +1,5 @@
+<% content_for :page_actions_dropdown do %>
+  <%= external_page_preview_link(@post) %>
+<% end %>
+
+<%= render 'spree/admin/shared/edit_resource', col_class: 'col-span-12' %>

data/app/views/spree/admin/posts/filters.html.erb

@@ -0,0 +1,39 @@
+<%= search_form_for [:admin, @search], class: "filter-wrap", data: {controller: "filters dialog"} do |f| %>
+    <div class="flex flex-col lg:flex-row gap-2">
+      <%= render 'spree/admin/shared/filters_search_bar', param: :search_by_title, label: Spree.t(:title) %>
+
+      <%= button_tag type: 'button', class: 'btn btn-light flex items-center', data: { action: 'dialog#open' } do %>
+        <%= icon "adjustments", class: "mr-1" %>
+        <%= Spree.t("admin.filters") %>
+      <% end %>
+    </div>
+
+  <%= drawer(id: 'posts-filters-drawer', controller_name: 'dialog') do %>
+    <%= drawer_header(Spree.t(:filter), 'dialog') %>
+    <div class="drawer-body">
+    <div class="form-group">
+      <%= f.label :author_id_eq, Spree.t(:author) %>
+      <%= f.select :author_id_eq,
+               options_for_select(post_authors_select_options, params.dig(:q, :author_id_eq)),
+               { include_blank: true },
+               { data: { filters_target: :input, controller: 'autocomplete-select' } } %>
+    </div>
+    <div class="form-group">
+      <%= f.label :post_category_id_eq, Spree.t(:category) %>
+      <%= f.select :post_category_id_eq,
+               options_for_select(@post_categories.pluck(:title, :id), params.dig(:q, :post_category_id_eq)),
+               { include_blank: true },
+               { data: { filters_target: :input, controller: 'autocomplete-select' } } %>
+    </div>
+    <%= render_admin_partials(:posts_filters_partials, f: f) %>
+    </div>
+    <div class="drawer-footer">
+      <%= drawer_discard_button('dialog') %>
+      <%= render 'spree/admin/shared/filter_submit' %>
+    </div>
+  <% end %>
+
+  <%= render "spree/admin/shared/filter_badge_template" %>
+
+  <div data-filters-target="badgesContainer" class="filter-badges-container"></div>
+<% end %>

data/app/views/spree/admin/posts/index.html.erb

@@ -0,0 +1,10 @@
+<%= render 'spree/admin/shared/posts_tabs' %>
+
+<% content_for :page_actions do %>
+  <%= render_admin_partials(:posts_actions_partials) %>
+  <%= link_to_with_icon 'plus', Spree.t(:new_post), new_object_url, class: 'btn btn-primary' if can?(:create, Spree::Post) %>
+<% end %>
+
+<%= render_admin_partials(:posts_header_partials) %>
+
+<%= render_table @collection, :posts %>

data/app/views/spree/admin/posts/new.html.erb

@@ -0,0 +1 @@
+<%= render 'spree/admin/shared/new_resource', col_class: 'col-span-12' %>

data/app/views/spree/admin/shared/_posts_tabs.html.erb

@@ -0,0 +1,8 @@
+<% content_for :page_title do %>
+  <%= Spree.t(:posts) %>
+<% end %>
+
+<% content_for(:page_tabs) do %>
+  <%= nav_item(Spree.t(:posts), spree.admin_posts_path) if can?(:manage, Spree::Post) %>
+  <%= nav_item(Spree.t(:categories), spree.admin_post_categories_path) if can?(:manage, Spree::PostCategory) %>
+<% end %>

data/config/initializers/spree.rb

@@ -0,0 +1,121 @@
+Rails.application.config.after_initialize do
+  # Dependencies
+  Spree::Dependencies.posts_finder = 'Spree::Posts::Find'
+  Spree::Dependencies.posts_sorter = 'Spree::Posts::Sort'
+
+  if defined?(Spree::Api)
+    Spree::Api::Dependencies.storefront_posts_finder = 'Spree::Posts::Find'
+    Spree::Api::Dependencies.storefront_posts_sorter = 'Spree::Posts::Sort'
+  end
+
+  # Metafields
+  Rails.application.config.spree.metafields.enabled_resources.push(Spree::Post, Spree::PostCategory)
+
+  # Admin navigation
+  if defined?(Spree::Admin) && Spree.respond_to?(:admin)
+    sidebar_nav = Spree.admin.navigation.sidebar
+
+    sidebar_nav.add :posts,
+            label: :posts,
+            url: :admin_posts_path,
+            icon: 'article',
+            position: 70,
+            active: -> { %w[posts post_categories].include?(controller_name) },
+            if: -> { can?(:manage, Spree::Post) }
+
+    # Admin tables
+    Spree.admin.tables.register(:posts, model_class: Spree::Post, search_param: :title_cont)
+
+    Spree.admin.tables.posts.add :title,
+                                       label: :title,
+                                       type: :link,
+                                       sortable: true,
+                                       filterable: true,
+                                       default: true,
+                                       position: 10
+
+    Spree.admin.tables.posts.add :post_category,
+                                       label: :category,
+                                       type: :string,
+                                       filter_type: :autocomplete,
+                                       sortable: false,
+                                       filterable: true,
+                                       default: true,
+                                       position: 20,
+                                       method: ->(post) { post.post_category_title },
+                                       ransack_attribute: 'post_category_id',
+                                       search_url: ->(view_context) { view_context.spree.select_options_admin_post_categories_path(format: :json) }
+
+    Spree.admin.tables.posts.add :author,
+                                       label: :author,
+                                       type: :string,
+                                       filter_type: :autocomplete,
+                                       sortable: false,
+                                       filterable: true,
+                                       default: true,
+                                       position: 30,
+                                       method: ->(post) { post.author_name },
+                                       ransack_attribute: 'author_id',
+                                       search_url: ->(view_context) { view_context.spree.select_options_admin_admin_users_path(format: :json) }
+
+    Spree.admin.tables.posts.add :published_at,
+                                       label: :published_at,
+                                       type: :date,
+                                       sortable: true,
+                                       filterable: true,
+                                       default: true,
+                                       position: 40
+
+    Spree.admin.tables.posts.add :created_at,
+                                       label: :created_at,
+                                       type: :datetime,
+                                       sortable: true,
+                                       filterable: true,
+                                       default: false,
+                                       position: 50
+
+    Spree.admin.tables.posts.add :updated_at,
+                                       label: :updated_at,
+                                       type: :datetime,
+                                       sortable: true,
+                                       filterable: true,
+                                       default: false,
+                                       position: 60
+
+    # Post Categories Table
+    Spree.admin.tables.register(:post_categories, model_class: Spree::PostCategory, search_param: :title_cont)
+
+    Spree.admin.tables.post_categories.add :title,
+                                                 label: :title,
+                                                 type: :link,
+                                                 sortable: true,
+                                                 filterable: true,
+                                                 default: true,
+                                                 position: 10
+
+    Spree.admin.tables.post_categories.add :posts_count,
+                                                 label: :posts,
+                                                 type: :number,
+                                                 sortable: false,
+                                                 filterable: false,
+                                                 default: true,
+                                                 position: 20,
+                                                 method: ->(post_category) { post_category.posts.count }
+
+    Spree.admin.tables.post_categories.add :created_at,
+                                                 label: :created_at,
+                                                 type: :datetime,
+                                                 sortable: true,
+                                                 filterable: true,
+                                                 default: false,
+                                                 position: 30
+
+    Spree.admin.tables.post_categories.add :updated_at,
+                                                 label: :updated_at,
+                                                 type: :datetime,
+                                                 sortable: true,
+                                                 filterable: true,
+                                                 default: false,
+                                                 position: 40
+  end
+end

data/config/locales/en.yml

@@ -0,0 +1,15 @@
+---
+en:
+  spree:
+    all_posts: All posts
+    all_posts_with_tag: All posts with tag
+    blog: Blog
+    blogs_posts: Blogs posts
+    default_post_categories:
+      articles: Articles
+      news: News
+      resources: Resources
+    new_post: New Post
+    new_post_category: New Post Category
+    post_categories: Post categories
+    posts: Posts

data/config/routes.rb

@@ -0,0 +1,14 @@
+Spree::Core::Engine.add_routes do
+  namespace :admin do
+    resources :posts do
+      collection do
+        get :select_options, defaults: { format: :json }
+      end
+    end
+    resources :post_categories do
+      collection do
+        get :select_options, defaults: { format: :json }
+      end
+    end
+  end
+end

data/db/migrate/20250121160028_create_spree_posts_and_spree_post_categories.rb

@@ -0,0 +1,33 @@
+class CreateSpreePostsAndSpreePostCategories < ActiveRecord::Migration[7.2]
+  def change
+    if !table_exists?(:spree_post_categories)
+      create_table :spree_post_categories do |t|
+        t.references :store, null: false, index: true
+        t.string :title, null: false
+        t.string :slug, null: false
+
+        t.timestamps
+
+        t.index ['slug', 'store_id'], name: 'index_spree_post_categories_on_slug_and_store_id', unique: true
+      end
+    end
+
+    if !table_exists?(:spree_posts)
+      create_table :spree_posts do |t|
+        t.references :author, index: true
+        t.datetime :published_at
+        t.string :title, null: false
+        t.string :slug, null: false
+        t.references :post_category, index: true
+        t.references :store, index: true
+        t.string :meta_title
+        t.string :meta_description
+
+        t.timestamps
+        t.datetime :deleted_at
+
+        t.index ['title'], name: 'index_spree_posts_on_title'
+      end
+    end
+  end
+end

data/lib/generators/spree_posts/install/install_generator.rb

@@ -0,0 +1,20 @@
+module SpreePosts
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      class_option :migrate, type: :boolean, default: true
+
+      def add_migrations
+        run 'bundle exec rake railties:install:migrations FROM=spree_posts'
+      end
+
+      def run_migrations
+        run_migrations = options[:migrate] || ['', 'y', 'Y'].include?(ask('Would you like to run the migrations now? [Y/n]'))
+        if run_migrations
+          run 'bin/rails db:migrate'
+        else
+          puts 'Skipping rails db:migrate, don\'t forget to run it!'
+        end
+      end
+    end
+  end
+end

data/lib/spree_posts/configuration.rb

@@ -0,0 +1,13 @@
+module SpreePosts
+  class Configuration < Spree::Preferences::Configuration
+
+   # Some example preferences are shown below, for more information visit:
+   # https://docs.spreecommerce.org/developer/contributing/creating-an-extension
+
+   # preference :enabled, :boolean, default: true
+   # preference :dark_chocolate, :boolean, default: true
+   # preference :color, :string, default: 'Red'
+   # preference :favorite_number, :integer
+   # preference :supported_locales, :array, default: [:en]
+  end
+end

data/lib/spree_posts/engine.rb

@@ -0,0 +1,24 @@
+module SpreePosts
+  class Engine < Rails::Engine
+    require 'spree/core'
+    isolate_namespace Spree
+    engine_name 'spree_posts'
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    initializer 'spree_posts.environment', before: :load_config_initializers do |_app|
+      SpreePosts::Config = SpreePosts::Configuration.new
+    end
+
+    def self.activate
+      Dir.glob(File.join(File.dirname(__FILE__), '../../app/**/*_decorator*.rb')) do |c|
+        Rails.configuration.cache_classes ? require(c) : load(c)
+      end
+    end
+
+    config.to_prepare(&method(:activate).to_proc)
+  end
+end

data/lib/spree_posts/factories.rb

@@ -0,0 +1,28 @@
+FactoryBot.define do
+  factory :post, class: Spree::Post do
+    store { Spree::Store.default || create(:store) }
+    post_category { association(:post_category, store: store) }
+    title { FFaker::Lorem.sentence }
+    content { FFaker::Lorem.paragraph }
+    published_at { Time.current }
+    association :author, factory: :admin_user
+
+    trait :with_image do
+      image { Rack::Test::UploadedFile.new(Spree::Core::Engine.root.join('spec/fixtures/thinking-cat.jpg'), 'image/jpeg') }
+    end
+
+    trait :published do
+      published_at { Time.current }
+    end
+
+    trait :unpublished do
+      published_at { nil }
+    end
+  end
+
+  factory :post_category, class: Spree::PostCategory do
+    sequence(:title) { |n| "Category ##{n + 1}" }
+    description { FFaker::Lorem.sentence }
+    store { Spree::Store.default || create(:store) }
+  end
+end

data/lib/spree_posts/version.rb

@@ -0,0 +1,7 @@
+module SpreePosts
+  VERSION = '1.0.0'.freeze
+
+  def gem_version
+    Gem::Version.new(VERSION)
+  end
+end

data/lib/spree_posts.rb

@@ -0,0 +1,12 @@
+require 'spree'
+require 'spree_posts/engine'
+require 'spree_posts/version'
+require 'spree_posts/configuration'
+
+module SpreePosts
+  mattr_accessor :queue
+
+  def self.queue
+    @@queue ||= Spree.queues.default
+  end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: spree_posts
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Vendo Connect Inc., Vendo Sp. z o.o.
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: spree
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.4.0.beta
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.4.0.beta
+- !ruby/object:Gem::Dependency
+  name: spree_admin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.4.0.beta
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.4.0.beta
+- !ruby/object:Gem::Dependency
+  name: spree_dev_tools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+email: hello@spreecommerce.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- Rakefile
+- app/controllers/spree/admin/post_categories_controller.rb
+- app/controllers/spree/admin/posts_controller.rb
+- app/finders/spree/posts/find.rb
+- app/helpers/spree/admin/posts_helper.rb
+- app/models/spree/post.rb
+- app/models/spree/post_category.rb
+- app/models/spree/store_decorator.rb
+- app/sorters/spree/posts/sort.rb
+- app/views/spree/admin/post_categories/_form.html.erb
+- app/views/spree/admin/post_categories/_table_header.html.erb
+- app/views/spree/admin/post_categories/_table_row.html.erb
+- app/views/spree/admin/post_categories/edit.html.erb
+- app/views/spree/admin/post_categories/index.html.erb
+- app/views/spree/admin/post_categories/new.html.erb
+- app/views/spree/admin/posts/_extra_actions.html.erb
+- app/views/spree/admin/posts/_form.html.erb
+- app/views/spree/admin/posts/_table_header.html.erb
+- app/views/spree/admin/posts/_table_row.html.erb
+- app/views/spree/admin/posts/edit.html.erb
+- app/views/spree/admin/posts/filters.html.erb
+- app/views/spree/admin/posts/index.html.erb
+- app/views/spree/admin/posts/new.html.erb
+- app/views/spree/admin/shared/_posts_tabs.html.erb
+- config/initializers/spree.rb
+- config/locales/en.yml
+- config/routes.rb
+- db/migrate/20250121160028_create_spree_posts_and_spree_post_categories.rb
+- lib/generators/spree_posts/install/install_generator.rb
+- lib/spree_posts.rb
+- lib/spree_posts/configuration.rb
+- lib/spree_posts/engine.rb
+- lib/spree_posts/factories.rb
+- lib/spree_posts/version.rb
+homepage: https://github.com/spree/spree-posts
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- none
+rubygems_version: 4.0.2
+specification_version: 4
+summary: Spree Commerce Posts Extension
+test_files: []