stipa 0.2.4 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 035d22e299975a792e6b72649c0160e6a9af69c1b50f5b529503e35e772f5cf6
-  data.tar.gz: df2d1f4bd439bb41f008e4468c19c0c9538f56ca820570e3afc46fce7b1f6bc0
+  metadata.gz: 007f691ff0ffe9eda4e751fe7d5839c71eaf1de64fbad49544c0e5e8cfc754df
+  data.tar.gz: e5f289efe22da0ec25c7e43c7a622d538de4a87f226b3e282d23b7f68c7bde06
 SHA512:
-  metadata.gz: 23b23d3954f3801027e4c396334cab70e3d3091e0ba4a305f740374172a160d489c7ba91eab9a37274f326c0d616bb0caf0d10e619b4ce0cd2e6f82f215d64da
-  data.tar.gz: e858a068ada0a89e2a7fb256718679fb55a428c1fd3da570bad18618851f50a922baa4dc015a81ef21d7709952e4569d7741ce2356028536b9efc659fe8f2d9f
+  metadata.gz: d750ef8b7affa8b8446a6af38b5be1b11fec7526a7132c78f6857c8da99005c30d2811b378e77fe40b5168108b48e1bbe988362abc186f7eabc762b1887e0af5
+  data.tar.gz: 2f5994e2de25d2d2c0f5cd7c1f2561e3f0e1b597891585afb97d5f955edf5002f2eead41020564d0c8f6039a76e066ba60a513d0769db4c9ae2ae10b7d98a6b9

data/README.md

@@ -430,13 +430,19 @@ result[:records]     # => [#<User>, ...]
 result[:total]       # => 150
 result[:total_pages] # => 15
 
-# Soft delete
+# Soft delete (requires a `deleted_at` column)
 user.soft_delete
 user.deleted?       # => true
-User.all            # => excludes soft-deleted
-User.with_deleted   # => includes all
-User.only_deleted   # => soft-deleted only
 user.restore
+
+# Scopes
+User.dataset.deleted       # => WHERE (deleted_at IS NOT NULL)
+User.dataset.not_deleted   # => WHERE (deleted_at IS NULL)
+
+# To exclude soft-deleted records by default, override dataset:
+#   def self.dataset
+#     super.not_deleted
+#   end
 ```
 
 ---

data/lib/stipa/generators/api.rb

@@ -35,6 +35,7 @@ module Stipa
           'controllers/application_controller.rb' => t_application_controller,
           'controllers/health_controller.rb'       => t_health_controller,
           'models/application_model.rb'            => t_application_model,
+          'models/post.rb'                         => t_sample_model,
           'db/migrate/001_create_posts.rb'         => t_migration_create_posts,
         }
       end

data/lib/stipa/generators/base.rb

@@ -188,19 +188,45 @@ module Stipa
         <<~RUBY
           # frozen_string_literal: true
 
+          Sequel::Model.require_valid_table = false
+
           require 'stipa/model'
 
-          # Include this in any Sequel::Model subclass to get
-          # timestamps, UUID, soft delete, and serialization.
+          # Base model class providing timestamps, UUID, soft delete,
+          # serialization, dirty tracking, and validation helpers.
           #
           # Usage:
-          #   class Post < Sequel::Model
-          #     include ApplicationModel
+          #   class Car < ApplicationModel
           #   end
 
-          module ApplicationModel
-            def self.included(base)
-              base.include Stipa::Model
+          class ApplicationModel < Sequel::Model
+            include Stipa::Model
+
+            # Ensure every subclass maps to its own table (e.g. Car → cars),
+            # not to the parent's abstract +application_models+ table.
+            def self.inherited(subclass)
+              super
+              subclass.set_dataset(subclass.implicit_table_name) unless subclass.name.to_s.empty?
+            end
+          end
+
+          Sequel::Model.require_valid_table = true
+        RUBY
+      end
+
+      def t_sample_model
+        <<~RUBY
+          # frozen_string_literal: true
+
+          class Post < ApplicationModel
+            def validate
+              super
+              errors.add(:title, 'is required') if title.to_s.strip.empty?
+              errors.add(:slug, 'is required') if slug.to_s.strip.empty?
+            end
+
+            def to_param
+              slug
             end
           end
         RUBY

data/lib/stipa/generators/vue.rb

@@ -71,6 +71,7 @@ module Stipa
           'app/controllers/home_controller.rb' => t_home_controller,
           'app/controllers/health_controller.rb' => t_health_controller,
           'app/models/application_model.rb' => t_application_model,
+          'app/models/post.rb' => t_sample_model,
           'db/migrate/001_create_posts.rb' => t_migration_create_posts,
           'app/views/layouts/application.html.erb' => t_layout,
           'app/views/home/index.html.erb' => t_home_index,

data/lib/stipa/model/soft_delete.rb

@@ -1,5 +1,35 @@
 module Stipa
   module Model
+    # Soft delete support for Sequel models.
+    #
+    # Provides `soft_delete`, `restore`, and `deleted?` instance methods,
+    # plus `deleted` and `not_deleted` dataset scopes.
+    #
+    # Your table must have a nullable `deleted_at` timestamp column.
+    #
+    #   # db/migrate/001_create_posts.rb
+    #   create_table :posts do
+    #     primary_key :id
+    #     DateTime :deleted_at
+    #     # ...
+    #   end
+    #
+    # ==== Opt into the default scope
+    #
+    # By default, soft-deleted rows are NOT filtered from queries.
+    # To exclude them automatically, override `dataset` in your model:
+    #
+    #   class Post < ApplicationModel
+    #     def self.dataset
+    #       super.not_deleted
+    #     end
+    #   end
+    #
+    #   Post.where(title: "foo")  # => WHERE (deleted_at IS NULL) AND (title = 'foo')
+    #
+    # Without the override, include records as usual:
+    #
+    #   Post.where(title: "foo")  # => WHERE (title = 'foo')
     module SoftDelete
       def self.included(base)
         base.instance_eval do
@@ -12,21 +42,25 @@ module Stipa
               where(deleted_at: nil)
             end
           end
-
-          def self.dataset
-            super.not_deleted
-          end
         end
       end
 
+      # Mark the record as soft-deleted.
+      #
+      #   post.soft_delete        # sets deleted_at = now
+      #   post.soft_delete        # no-op (already deleted)
       def soft_delete
         update(deleted_at: Time.now.utc)
       end
 
+      # Restore a soft-deleted record.
+      #
+      #   post.restore            # sets deleted_at = nil
       def restore
         update(deleted_at: nil)
       end
 
+      # Returns +true+ if the record has been soft-deleted.
       def deleted?
         !deleted_at.nil?
       end

data/lib/stipa/model/uuid.rb

@@ -4,8 +4,11 @@ module Stipa
   module Model
     module UUID
       def self.included(base)
-        base.instance_eval do
-          before_create { self.id ||= SecureRandom.uuid }
+        base.class_eval do
+          def before_create
+            self.id ||= SecureRandom.uuid
+            super
+          end
         end
       end
 

data/lib/stipa/version.rb

@@ -1,3 +1,3 @@
 module Stipa
-  VERSION = '0.2.4'
+  VERSION = '0.2.6'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stipa
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.6
 platform: ruby
 authors:
 - Jānis Harbs