twinkle 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8ac554f1dff3ef39f4915f981ec076b50702272d4e580fd53c883065b01c430
-  data.tar.gz: dc5f679b7366c31e316f067886298f5408b32d11706bdd56de76a95ad6550685
+  metadata.gz: 11aec611ab42595799ef8573c3c4531ddc4de266cc493f6e489259d14c0bb4be
+  data.tar.gz: 47e2fb84ddc979e4cd5c9389c578f71c28d4c080c8732ae5368638352b4bbaea
 SHA512:
-  metadata.gz: 37eaf8576e4d1b47332eb5fd48c082cb08b75df2578bba102308d5d74e550e3964bbae168a462297e4af2b78f9f78d5a9f0cbe1c2041cc9236f38b13d8ebeaa2
-  data.tar.gz: 9fcf89b14a7a6b945fe607af393db115f79d28b29a4d33585844b82009455103871060dffcc41e0017ef597ef6a05a92091410fd012fc30964fb7d1156a25181
+  metadata.gz: 8459279d6a1ee5d1f4ad47df0da68948024ef60d95cdf86ded42ac77f54c636149de394dbb69fd23b78fe2f9764d7cea8f10dad066d3d159047de96ce222092b
+  data.tar.gz: adf1ab532210ac62d886c5a769c03d282aecef5bb25714bfa51af27293c1bc516f7c5dc483c5dcd984e90faea8c7895eea9705bc3cfbccc369ad2febc07e11f7

data/README.md

@@ -46,10 +46,30 @@ mount Twinkle::Engine => "/"
 
 This will mount the appcast routes at /updates/:app.slug
 
+## Extending Twinkle Apps
+
+You can extend the Twinkle::App model by creating app/models/twinkle/app.rb
+
+```ruby
+class Twinkle::App < ApplicationRecord
+  include Twinkle::Concerns::Models::App
+  include Summarize
+
+  # Your custom app code and validations etc go here
+end
+```
+
 ## Contributing
 
 Pull requests welcome.
 
+## Building the gem
+
+```bash
+gem build
+gem push twinkle-x.x.x.gem
+```
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/models/concerns/summarize.rb

@@ -4,7 +4,7 @@ module Summarize
   included do
     def summarize_events(period, start_date, end_date)
       # Find or create a summary for the week
-      summary = Twinkle::Summary.with_datapoints.find_or_create_by(app: self, period: period, start_date: start_date, end_date: end_date)
+      summary = Twinkle::Summary.find_or_create_by(app: self, period: period, start_date: start_date, end_date: end_date)
       data_hash = get_data_hash(start_date, end_date)
       datapoints = get_datapoints(summary, data_hash)
       save_summary(datapoints)
@@ -17,7 +17,7 @@ module Summarize
       events.created_between(start_date, end_date).find_each do |event|
         data_hash['users']['sessions'] = (data_hash.dig('users', 'sessions') || 0) + 1
         Twinkle::Event.fields.each do |field|
-          data_hash[field][event[field]] = (data_hash.dig(field, event[field]) || 0) + 1
+          data_hash[field][event[field]] = (data_hash.dig(field, event[field]) || 0) + 1 if event[field].present?
         end
       end
       data_hash

data/app/models/twinkle/app.rb

@@ -1,19 +1,6 @@
 module Twinkle
   class App < ApplicationRecord
+    include Twinkle::Concerns::Models::App
     include Summarize
-    
-    has_many :versions, foreign_key: 'twinkle_app_id', class_name: 'Twinkle::Version'
-    has_many :events, foreign_key: 'twinkle_app_id', class_name: 'Twinkle::Event'
-    has_many :summaries, foreign_key: 'twinkle_app_id', class_name: 'Twinkle::Summary'
-    has_one_attached :icon
-
-    scope :with_versions, -> { includes(:versions).order('twinkle_versions.build desc') }
-    scope :with_latest_version, -> { includes(:versions).order('twinkle_versions.build desc').limit(1) }
-    scope :with_latest_summary, -> { includes(:summaries).order('twinkle_summaries.created_at desc').limit(1) }
-    scope :with_summaries_since, ->(date) { includes(:summaries).where('twinkle_summaries.start >= ?', date).order('twinkle_summaries.start asc') }
-
-    validates :name, presence: true
-    validates :slug, presence: true, uniqueness: true
-    validates :description, presence: true
   end
 end

data/app/models/twinkle/summary.rb

@@ -1,10 +1,13 @@
 module Twinkle
   class Summary < ApplicationRecord
     belongs_to :app, foreign_key: :twinkle_app_id, class_name: 'Twinkle::App'
-    has_many :datapoints, foreign_key: :twinkle_summary_id, class_name: 'Twinkle::Datapoint'
+    has_many :datapoints, foreign_key: :twinkle_summary_id, class_name: 'Twinkle::Datapoint', dependent: :delete_all
 
+    # Virtual relationships
+    has_one :latest_user_summary, -> { where(name: 'users').order('twinkle_datapoints.value desc').limit(1) }, foreign_key: :twinkle_summary_id, class_name: 'Twinkle::Datapoint'
+
+    scope :since, ->(date) { where('twinkle_summaries.start_date >= ?', date).order('twinkle_summaries.start_date asc') }
     scope :week_of, -> (start_date, end_date) { where(period: :week).where("start_date >= ? AND end_date <= ?", start_date, end_date) }
-    scope :with_datapoints, -> { includes(:datapoints) }
 
     enum period: { week: 0, fortnight: 1, month: 2 }
 

data/app/models/twinkle/version.rb

@@ -6,20 +6,22 @@ module Twinkle
 
     validates :number, presence: true
     validates :build, presence: true
-    validates :description, presence: true
-    validates :binary_url, presence: true
-    validates :length, presence: true
-    validates :length, numericality: { only_integer: true, greater_than: 0 }
+    validates :description, presence: true, if: -> { published }
+    validates :binary_url, presence: true, if: -> { published }
+    validates :length, presence: true, if: -> { published }
+    validates :length, numericality: { only_integer: true, greater_than: 0 }, allow_blank: true
+
 
     # validates that the binary_url is a valid URL
     validate :binary_url_is_url
 
     # validates that one of the two signatures is present
-    validate :signature_present
+    validate :signature_present, if: -> { published }
 
     private 
 
     def binary_url_is_url
+      return true if binary_url.blank?
       begin
         uri = URI.parse(binary_url)
         raise URI::InvalidURIError unless uri.is_a?(URI::HTTP) && uri.host.present?

data/db/migrate/20240517232121_create_twinkle_versions.rb

@@ -12,6 +12,6 @@ class CreateTwinkleVersions < ActiveRecord::Migration[7.1]
 
       t.timestamps
     end
-    add_index :twinkle_versions, :build
+    add_index :twinkle_versions, [:twinkle_app_id, :build], unique: true
   end
 end

data/db/migrate/20240517234016_create_twinkle_summaries.rb

@@ -8,6 +8,6 @@ class CreateTwinkleSummaries < ActiveRecord::Migration[7.1]
 
       t.timestamps
     end
-    add_index :twinkle_summaries, [:period, :start_date, :end_date]
+    add_index :twinkle_summaries, [:period, :start_date, :end_date], unique: true
   end
 end

data/db/migrate/20240530023848_add_published_to_twinkle_versions.rb

@@ -0,0 +1,6 @@
+class AddPublishedToTwinkleVersions < ActiveRecord::Migration[7.1]
+  def change
+    add_column :twinkle_versions, :published, :boolean, default: false, null: false
+    add_index :twinkle_versions, [:twinkle_app_id, :published]
+  end
+end

data/lib/twinkle/concerns/models/app.rb

@@ -0,0 +1,24 @@
+module Twinkle
+  module Concerns
+    module Models
+      module App
+        extend ActiveSupport::Concern
+
+        included do
+          has_many :versions,  -> { order('twinkle_versions.build desc') }, foreign_key: 'twinkle_app_id', class_name: 'Twinkle::Version', dependent: :destroy
+          has_many :events, foreign_key: 'twinkle_app_id', class_name: 'Twinkle::Event', dependent: :delete_all
+          has_many :summaries, foreign_key: 'twinkle_app_id', class_name: 'Twinkle::Summary', dependent: :destroy
+          has_one_attached :icon
+
+          # Virtual relationships
+          has_one :latest_version, -> { order('twinkle_versions.build desc').limit(1) }, foreign_key: 'twinkle_app_id', class_name: 'Twinkle::Version'
+          has_one :latest_weekly_summary, -> { where(period: :week).order('twinkle_summaries.start_date desc').limit(1) }, foreign_key: 'twinkle_app_id', class_name: 'Twinkle::Summary'
+
+          validates :name, presence: true
+          validates :slug, presence: true, uniqueness: true
+          validates :description, presence: true
+        end
+      end
+    end
+  end
+end

data/lib/twinkle/version.rb

@@ -1,3 +1,3 @@
 module Twinkle
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/twinkle.rb

@@ -1,5 +1,6 @@
 require "twinkle/version"
 require "twinkle/engine"
+require "twinkle/concerns/models/app"
 
 module Twinkle
   # Your code goes here...

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: twinkle
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Tim Marks
@@ -57,12 +57,15 @@ files:
 - db/migrate/20240517233457_create_twinkle_events.rb
 - db/migrate/20240517234016_create_twinkle_summaries.rb
 - db/migrate/20240518000405_create_twinkle_datapoints.rb
+- db/migrate/20240530023848_add_published_to_twinkle_versions.rb
 - lib/tasks/twinkle_tasks.rake
 - lib/twinkle.rb
+- lib/twinkle/concerns/models/app.rb
 - lib/twinkle/engine.rb
 - lib/twinkle/version.rb
 homepage: https://github.com/imothee/twinkle
-licenses: []
+licenses:
+- MIT
 metadata:
   allowed_push_host: https://rubygems.org/
   homepage_uri: https://github.com/imothee/twinkle