twenty-server 0.5.3 → 0.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 394570c5ad631e7055dad0bc3b62b022e6ee97de39d28b5aab95613f04924b0c
-  data.tar.gz: 543f8ff17382dce3574eb18c0fa12508881e54af6427dc3db6a91e625d285f3d
+  metadata.gz: '09a7504d2ef036f0463b573bd999ec4df8fa5e32a48bd40e7e91e947e5f1a25d'
+  data.tar.gz: 6a0e602227119bf35e1857525994e0b019061bc234a0913fc6c9a58dabfbf1da
 SHA512:
-  metadata.gz: 18f4c98db2fb61d9d9d0f8a1b0bcd886629beb7b319f4cbb9019f7d42e4e20487504d35fb1d41fd13d96a31635d2015748ed8b02ab91e436b30f8fb1d2e87cf8
-  data.tar.gz: 1052e7a9e7517fd6047bde5d61b459f7413e356e239d1b6436e4ee478898adbe7b07f9c2c9bbbf8000ee0995107edce2792ae4d685a467b3b2e4827cafd31334
+  metadata.gz: 06e09450ff1212091122d480fcb77c3f6d2c319eed0b998986d541f1c5df730cd67b7a98b861336c6dc195e6e46c1d1f452ec09dc39813a177ab80834831b84b
+  data.tar.gz: a3adb49e1dd8132ceebfb0d78638d175a0d0a72fab31d12de7445633328e0a8921b68265d7a8c6bffbb3bc3e51d829db7b062a38ae1c4b17a68e585a3610f0b5

data/lib/twenty/server/migration/3_add_color_to_projects.rb

@@ -2,7 +2,7 @@
 
 Sequel.migration do
   up do
-    default = Twenty::ColorableMixin.random_color
+    default = Twenty::Mixin::Colorable.random_color
     add_column :projects, :color, :string, null: false, default:
   end
 

data/lib/twenty/server/migration.rb

@@ -1,25 +1,26 @@
 # frozen_string_literal: true
 
 module Twenty::Migration
-  require "sequel/extensions/migration"
+  Sequel.extension(:migration)
+
   ##
   # @return [String]
-  #  Returns the path to twenty's migrations.
+  #  Returns the path to the migrations directory
   def self.migrations_path
     File.join(__dir__, "migration")
   end
 
   ##
-  # Runs migrations (if neccessary).
+  # Run migrations
   # @return [void]
-  def self.run!
-    Sequel::Migrator.run(Twenty.connection, migrations_path)
+  def self.run!(options = {})
+    Sequel::Migrator.run(Twenty.connection, migrations_path, options)
   end
 
   ##
   # @return [Boolean]
-  #  Returns true when there are pending migrations.
+  #  Returns true when there are pending migrations
   def self.pending_migrations?
-    Sequel::Migrator.is_current?(Twenty.connection, migrations_path)
+    ! Sequel::Migrator.is_current?(Twenty.connection, migrations_path)
   end
 end

data/lib/twenty/server/mixin/colorable.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Twenty::Mixin
+  module Colorable
+    extend self
+
+    COLORS = [
+      "#222222", "#333333", "#444444", "#555555", "#666666",
+      "#777777", "#888888", "#999999", "#AA2222", "#22AA22",
+      "#2222AA", "#AA22AA", "#CC9900", "#0099CC", "#9900CC",
+      "#FF9900", "#00CC99", "#99CC00", "#CC0099", "#990000",
+      "#112233", "#445566", "#778899", "#AA4455", "#5544AA",
+      "#88AA44", "#AA88AA", "#CCBB00", "#1155CC", "#9900BB",
+      "#DD6600", "#00BBCC", "#CC0099", "#BB3300", "#006688",
+      "#993366", "#2200AA", "#557788", "#998877", "#BB4400"
+    ]
+
+    def before_validation
+      super if defined?(super)
+      set_random_color
+    end
+
+    def random_color
+      COLORS.sample
+    end
+
+    private
+
+    def set_random_color
+      return if id
+      self.color = random_color
+    end
+  end
+end

data/lib/twenty/server/mixin.rb

@@ -0,0 +1,3 @@
+module Twenty::Mixin
+  require_relative "mixin/colorable"
+end

data/lib/twenty/server/model/project.rb

@@ -1,42 +1,44 @@
 # frozen_string_literal: true
 
-class Twenty::Project < Sequel::Model
-  include Twenty::Model
-  include Twenty::ColorableMixin
+module Twenty
+  class Project < Sequel::Model
+    include Model
+    include Mixin::Colorable
 
-  validates_presence_of :name
-  validates_presence_of :path
-  one_to_many :tasks, class_name: "Twenty::Task"
+    validates_presence_of :name
+    validates_presence_of :path
+    one_to_many :tasks, class_name: "Twenty::Task"
 
-  ##
-  # @api private
-  def validate
-    super
-    errors.add(:path, "does not exist on disk") if !path_exist?
-    errors.add(:path, "is not absolute") if !File.absolute_path?(self[:path])
-  end
+    ##
+    # @api private
+    def validate
+      super
+      errors.add(:path, "does not exist on disk") if !path_exist?
+      errors.add(:path, "is not absolute") if !File.absolute_path?(self[:path])
+    end
 
-  ##
-  # @return [String]
-  #  The path to a project
-  def path
-    super&.sub(Dir.home, "~")
-  end
+    ##
+    # @return [String]
+    #  The path to a project
+    def path
+      super&.sub(Dir.home, "~")
+    end
 
-  ##
-  # @return [Boolean]
-  #  Returns true when {#path} exists on disk
-  def path_exist?
-    File.exist? File.expand_path(path)
-  end
+    ##
+    # @return [Boolean]
+    #  Returns true when {#path} exists on disk
+    def path_exist?
+      File.exist? File.expand_path(path)
+    end
 
-  ##
-  # @return [Integer]
-  #  Returns the number of open tasks a project has
-  def open_task_count
-    @open_task_count ||= Twenty::Task
-                           .where(project_id: id)
-                           .where(Sequel.lit("status IN (0,1,2)"))
-                           .count
+    ##
+    # @return [Integer]
+    #  Returns the number of open tasks a project has
+    def open_task_count
+      @open_task_count ||= Twenty::Task
+                             .where(project_id: id)
+                             .where(Sequel.lit("status IN (0,1,2)"))
+                             .count
+    end
   end
 end

data/lib/twenty/server/model.rb

@@ -6,7 +6,6 @@ module Twenty::Model
     model.plugin(:timestamps, update_on_create: true)
   end
 
-  require_relative "model/mixin/colorable_mixin"
   require_relative "model/project"
   require_relative "model/task"
 end

data/lib/twenty/server.rb

@@ -1,22 +1,49 @@
 # frozen_string_literal: true
 
 module Twenty
-  require "fileutils"
-  require "sequel"
-  require_relative "server/path"
+  extend Module.new {
+    require "tmpdir"
+    require "fileutils"
+    extend self
+    extend FileUtils
 
-  ##
-  # @return [String]
-  #  Returns the location of the default SQLite database.
-  def self.default_database
-    @default_database ||= File.join(Path.datadir, "database.sqlite")
-  end
+    ##
+    # @return [String]
+    #  Returns the path for the default SQLite database
+    def default_database
+      @default_database ||= File.join(datadir, "database.sqlite")
+    end
+
+    ##
+    # @return [String]
+    #  Returns the directory where twenty stores data
+    def datadir
+      File.join(Dir.home, ".local", "share", "twenty")
+    end
+
+    ##
+    # @return [String]
+    #  Returns the directory where twenty stores temporary data
+    def tmpdir
+      File.join(Dir.tmpdir, "twenty")
+    end
+
+    ##
+    # @return [String]
+    #  Returns the path to a PID file
+    def pid
+      File.join(tmpdir, "server.pid")
+    end
+
+    mkdir_p(datadir)
+    mkdir_p(tmpdir)
+  }
 
   ##
-  # Establishes a database connection.
+  # Establishes a database connection
   #
   # @param [String] path
-  #  The path to a SQLite3 database file.
+  #  The path to a SQLite database
   #
   # @return [void]
   def self.establish_connection(path:)
@@ -26,12 +53,17 @@ module Twenty
     )
   end
 
+  ##
+  # @return [Sequel::Database::SQLite]
+  #  Returns the connection to a database
   def self.connection
     establish_connection unless @connection
     @connection
   end
 
-  FileUtils.touch(default_database)
+  require "sequel"
+  require_relative "server/mixin"
+  require_relative "server/migration"
   require_relative "server/graphql"
   require_relative "server/rack"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: twenty-server
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.5.5
 platform: ruby
 authors:
 - '0x1eef'
@@ -94,7 +94,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.35'
-description: HTTP server
+description: Provides the server component of twenty. See https://rubygems.org/gems/twenty
+  for context.
 email:
 - 0x1eef@protonmail.com
 executables: []
@@ -122,11 +123,11 @@ files:
 - "./lib/twenty/server/migration/1_create_projects.rb"
 - "./lib/twenty/server/migration/2_create_tasks.rb"
 - "./lib/twenty/server/migration/3_add_color_to_projects.rb"
+- "./lib/twenty/server/mixin.rb"
+- "./lib/twenty/server/mixin/colorable.rb"
 - "./lib/twenty/server/model.rb"
-- "./lib/twenty/server/model/mixin/colorable_mixin.rb"
 - "./lib/twenty/server/model/project.rb"
 - "./lib/twenty/server/model/task.rb"
-- "./lib/twenty/server/path.rb"
 - "./lib/twenty/server/rack.rb"
 - "./lib/twenty/server/rack/graphql.rb"
 - "./share/twenty/server/schema.graphql"
@@ -152,5 +153,5 @@ requirements: []
 rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
-summary: HTTP server
+summary: Provides the server component of twenty
 test_files: []

data/lib/twenty/server/model/mixin/colorable_mixin.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-module Twenty::ColorableMixin
-  extend self
-
-  COLORS = [
-    "#222222", "#333333", "#444444", "#555555", "#666666",
-    "#777777", "#888888", "#999999", "#AA2222", "#22AA22",
-    "#2222AA", "#AA22AA", "#CC9900", "#0099CC", "#9900CC",
-    "#FF9900", "#00CC99", "#99CC00", "#CC0099", "#990000",
-    "#112233", "#445566", "#778899", "#AA4455", "#5544AA",
-    "#88AA44", "#AA88AA", "#CCBB00", "#1155CC", "#9900BB",
-    "#DD6600", "#00BBCC", "#CC0099", "#BB3300", "#006688",
-    "#993366", "#2200AA", "#557788", "#998877", "#BB4400"
-  ]
-
-  def before_validation
-    super if defined?(super)
-    set_random_color
-  end
-
-  def random_color
-    COLORS.sample
-  end
-
-  private
-
-  def set_random_color
-    return if id
-    self.color = random_color
-  end
-end

data/lib/twenty/server/path.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-module Twenty::Path
-  require "tmpdir"
-  extend self
-
-  ##
-  # @return [String]
-  #  Returns the directory where twenty stores persistent data.
-  def datadir
-    File.join(Dir.home, ".local", "share", "twenty")
-  end
-
-  ##
-  # @return [String]
-  #  Returns the directory where twenty stores temporary data.
-  def tmpdir
-    File.join(Dir.tmpdir, "twenty")
-  end
-
-  ##
-  # @return [String]
-  #  Returns the file where twenty can write the PID of
-  #  a web server running in the background.
-  def pidfile
-    File.join(tmpdir, "server.pid")
-  end
-
-  FileUtils.mkdir_p(datadir)
-  FileUtils.mkdir_p(tmpdir)
-end