nvim_conf 0.1.0 → 0.1.1

data/lib/nvim_conf/writers/code/plugins/packer.rb

@@ -0,0 +1,94 @@
+require "nvim_conf/models/plugin"
+
+module NvimConf
+  module Writers
+    module Code
+      module Plugins
+        class Packer
+          BOOTSTRAP_HEADER = <<~BOOTSTRAP_HEADER
+            local fn = vim.fn
+            local install_path = fn.stdpath('data')..'/site/pack/packer/start/packer.nvim'
+            if fn.empty(fn.glob(install_path)) > 0 then
+              packer_bootstrap = fn.system({'git', 'clone', '--depth', '1', 'https://github.com/wbthomason/packer.nvim', install_path})
+            end\n
+          BOOTSTRAP_HEADER
+
+          BOOTSTRAP_TAIL = <<~BOOTSTRAP_TAIL
+            if packer_bootstrap then
+                require('packer').sync()
+              end
+          BOOTSTRAP_TAIL
+
+          BLOCK_START = <<~START
+            require('packer').startup(function(use)\n
+          START
+
+          BLOCK_END = <<~END
+            end)
+          END
+
+          def initialize(manager, io, configuration)
+            @manager = manager
+            @io = io
+            @configuration = configuration
+            @plugins = install_self(manager.plugins)
+          end
+
+          def write
+            write_start_of_bootstrap
+            @io.write(
+              BLOCK_START
+            )
+
+            @plugins.each do |plugin|
+              @io.write(
+                "#{plugin_indent(@configuration[:generator].new(plugin).generate)}\n"
+              )
+            end
+
+            write_tail_of_bootstrap
+
+            @io.write(
+              BLOCK_END
+            )
+          end
+
+          private
+
+          def write_start_of_bootstrap
+            return unless bootstrap?
+
+            @io.write(
+              BOOTSTRAP_HEADER
+            )
+          end
+
+          def install_self(plugins)
+            [Models::Plugin.new("wbthomason/packer.nvim")] + plugins
+          end
+
+          def write_tail_of_bootstrap
+            return unless bootstrap?
+
+            @io.write("\n")
+            @io.write(
+              plugin_indent(BOOTSTRAP_TAIL)
+            )
+            @io.write("\n")
+          end
+
+          def bootstrap?
+            @manager.bootstraped
+          end
+
+          def plugin_indent(content)
+            [
+              " " * @configuration[:indent],
+              content
+            ].join
+          end
+        end
+      end
+    end
+  end
+end

data/lib/nvim_conf/writers/code/plugins/paq.rb

@@ -0,0 +1,49 @@
+module NvimConf
+  module Writers
+    module Code
+      module Plugins
+        class Paq
+          BLOCK_START = <<~START
+            require "paq" {
+          START
+
+          BLOCK_END = <<~END
+            }
+          END
+
+          def initialize(manager, io, configuration)
+            @manager = manager
+            @io = io
+            @configuration = configuration
+            @plugins = manager.plugins
+          end
+
+          def write
+            @io.write(
+              BLOCK_START
+            )
+
+            @plugins.each do |plugin|
+              @io.write(
+                "#{plugin_indent(@configuration[:generator].new(plugin).generate)}\n"
+              )
+            end
+
+            @io.write(
+              BLOCK_END
+            )
+          end
+
+          private
+
+          def plugin_indent(content)
+            [
+              " " * @configuration[:indent],
+              content
+            ].join
+          end
+        end
+      end
+    end
+  end
+end

data/lib/nvim_conf/writers/code/requires.rb

@@ -0,0 +1,36 @@
+require "nvim_conf/generators/code/requires/lua"
+
+module NvimConf
+  module Writers
+    module Code
+      class RequiresWriter
+        REQUIRE_GENERATOR_MAPPING = {
+          lua: Generators::Requires::Code::Lua
+        }
+
+        def initialize(manager, io, format: :lua, commented: false)
+          @manager = manager
+          @io = io
+          @format = format
+        end
+
+        def write
+          @manager.requires.each do |require|
+            @io.write(
+              [
+                generator_class.new(require).generate,
+                "\n"
+              ].join
+            )
+          end
+        end
+
+        private
+
+        def generator_class
+          REQUIRE_GENERATOR_MAPPING[@format]
+        end
+      end
+    end
+  end
+end

data/lib/nvim_conf/writers/documentation/globals.rb

@@ -0,0 +1,45 @@
+module NvimConf
+  module Writers
+    module Documentation
+      class Globals
+        def initialize(managers, io)
+          @managers = managers
+          @io = io
+        end
+
+        def aggregate_writes
+          return if @managers.nil? || @managers.empty?
+
+          @io.write(
+            Utils::MarkdownFormatter.format_title(
+              "Globals",
+              level: 2
+            )
+          )
+
+          write_globals
+        end
+
+        private
+
+        def write_globals
+          @managers.map(&:globals).flatten.each do |global|
+            @io.write(
+              [
+                "- #{global.name}",
+                transformed_value(global.value)
+              ].join(" => ") + "\n"
+            )
+          end
+        end
+
+        def transformed_value(value)
+          return value.join(", ") if value.is_a?(Array)
+          return value unless value.nil?
+
+          value
+        end
+      end
+    end
+  end
+end

data/lib/nvim_conf/writers/documentation/mappings.rb

@@ -2,9 +2,6 @@ module NvimConf
   module Writers
     module Documentation
       class Mappings
-        MAIN_HEADER_PREFIX = "##"
-        MAPPING_HEADER_PREFIX = "###"
-
         def initialize(managers, io)
           @managers = managers
           @io = io
@@ -14,9 +11,9 @@ module NvimConf
           return if @managers.empty?
 
           @io.write(
-            title(
+            Utils::MarkdownFormatter.format_title(
               "Mappings",
-              MAIN_HEADER_PREFIX
+              level: 2
             )
           )
 
@@ -27,12 +24,12 @@ module NvimConf
 
         def write_mappings(grouped_mappings)
           grouped_mappings.each do |operator, mappings|
-            write_separator
+            @io.write_separator
 
             @io.write(
-              title(
+              Utils::MarkdownFormatter.format_title(
                 operator,
-                MAPPING_HEADER_PREFIX
+                level: 3
               )
             )
 
@@ -50,16 +47,6 @@ module NvimConf
         def all_mappings
           @managers.map(&:mappings).flatten
         end
-
-        def write_separator
-          @io.write(
-            "\n\n"
-          )
-        end
-
-        def title(text, prefix)
-          "#{prefix} #{text}\n"
-        end
       end
     end
   end

data/lib/nvim_conf/writers/documentation/orchestrator.rb

@@ -1,11 +1,13 @@
 require "nvim_conf/writers/documentation/mappings"
+require "nvim_conf/writers/documentation/globals"
 require "nvim_conf/writers/documentation/settings"
+require "nvim_conf/writers/documentation/plugins"
 
 module NvimConf
   module Writers
     module Documentation
       class Orchestrator
-        NON_WRITABLE_MANAGER = NvimConf::CompilerConfigurations::Manager
+        NON_WRITABLE_MANAGER = NvimConf::Managers::CompilerConfigurations
 
         def initialize(managers, io, configuration = nil)
           @managers = managers
@@ -18,16 +20,33 @@ module NvimConf
 
           write_main_header
 
-          {
-            NvimConf::Writers::Documentation::Settings => NvimConf::Settings::Manager,
-            NvimConf::Writers::Documentation::Mappings => NvimConf::Mappings::Manager
-          }.each do |writer_class, manager_class|
+          writers = [
+            [
+              NvimConf::Writers::Documentation::Settings, NvimConf::Managers::Settings
+            ],
+            [
+              NvimConf::Writers::Documentation::Mappings, NvimConf::Managers::Mappings
+            ],
+            [
+              NvimConf::Writers::Documentation::Plugins, NvimConf::Managers::Plugins
+            ],
+            [
+              NvimConf::Writers::Documentation::Globals, NvimConf::Managers::Globals
+            ]
+          ]
+
+          writers.each_with_index do |relevant_classes, index|
+            writer_class, manager_class = *relevant_classes
+            managers = @managers.select { |manager| manager.instance_of?(manager_class) }
+
+            next if managers.length.zero?
+
             writer_class.new(
-              @managers.select { |manager| manager.instance_of?(manager_class) },
+              managers,
               @io
             ).aggregate_writes
 
-            @io.write("\n\n")
+            @io.write("\n\n") if index != (writers.length - 1)
           end
         end
 

data/lib/nvim_conf/writers/documentation/plugins.rb

@@ -0,0 +1,54 @@
+module NvimConf
+  module Writers
+    module Documentation
+      class Plugins
+        def initialize(managers, io)
+          @managers = managers
+          @io = io
+        end
+
+        def aggregate_writes
+          return if @managers.empty?
+
+          @io.write(
+            Utils::MarkdownFormatter.format_title(
+              "Plugins",
+              level: 2
+            )
+          )
+
+          write_plugins
+        end
+
+        private
+
+        def write_plugins
+          @managers.each do |manager|
+            @io.write(
+              Utils::MarkdownFormatter.format_title(
+                manager.name.capitalize,
+                level: 3
+              )
+            )
+
+            manager.plugins.each do |plugin|
+              @io.write(
+                Utils::MarkdownFormatter.collapisible(
+                  plugin.name,
+                  plugin_url(plugin.name)
+                )
+              )
+              @io.write("\n")
+            end
+
+            @io.write_separator
+          end
+        end
+
+        def plugin_url(name)
+          "https://github.com/#{name}"
+        end
+      end
+    end
+  end
+end

data/lib/nvim_conf/writers/documentation/settings.rb

@@ -2,8 +2,6 @@ module NvimConf
   module Writers
     module Documentation
       class Settings
-        MAIN_HEADER_PREFIX = "##"
-
         def initialize(managers, io)
           @managers = managers
           @io = io
@@ -13,9 +11,9 @@ module NvimConf
           return if @managers.empty?
 
           @io.write(
-            title(
+            Utils::MarkdownFormatter.format_title(
               "Settings",
-              MAIN_HEADER_PREFIX
+              level: 2
             )
           )
 
@@ -26,12 +24,12 @@ module NvimConf
 
         def write_settings_groups(groups)
           groups.each do |operation, settings|
-            write_separator
+            @io.write_separator
 
             @io.write(
-              title(
+              Utils::MarkdownFormatter.format_title(
                 operation.capitalize,
-                "###"
+                level: 3
               )
             )
 
@@ -40,13 +38,18 @@ module NvimConf
                 [
                   "- #{setting.key}",
                   transformed_value(setting, setting.value)
-                ].join(" => ") + "\n"
+                ].join(operator(setting)) + "\n"
               )
             end
           end
         end
 
+        def operator(setting)
+          %i[set unset].include?(setting.operation) ? " => " : " += "
+        end
+
         def transformed_value(setting, value)
+          return value.join(", ") if value.is_a?(Array)
           return value unless value.nil?
 
           setting.operation == :set
@@ -55,16 +58,6 @@ module NvimConf
         def all_settings
           @managers.map(&:settings).flatten
         end
-
-        def write_separator
-          @io.write(
-            "\n\n"
-          )
-        end
-
-        def title(text, prefix)
-          "#{prefix} #{text}\n"
-        end
       end
     end
   end

data/lib/nvim_conf.rb

@@ -1,17 +1,22 @@
 # frozen_string_literal: true
 
 require "nvim_conf/version"
-require "set"
 require "nvim_conf/core"
 require "nvim_conf/writer"
-require "nvim_conf/manager"
+require "nvim_conf/commenter"
 require "nvim_conf/configuration_builder"
-require "nvim_conf/plugins/manager"
-require "nvim_conf/settings/manager"
-require "nvim_conf/mappings/manager"
-require "nvim_conf/compiler_configurations/manager"
+require "nvim_conf/managers/plugins"
+require "nvim_conf/managers/settings"
+require "nvim_conf/managers/mappings"
+require "nvim_conf/managers/requires"
+require "nvim_conf/managers/globals"
+require "nvim_conf/managers/commands"
+require "nvim_conf/managers/compiler_configurations"
+require "nvim_conf/utils/markdown_formatter"
+require "nvim_conf/utils/io_operator"
 require "nvim_conf/generators/code/settings/lua"
 require "nvim_conf/generators/code/plugins/packer"
+require "nvim_conf/generators/code/plugins/paq"
 require "nvim_conf/generators/code/settings/vim"
 require "nvim_conf/generators/code/mappings/lua"
 require "nvim_conf/generators/code/mappings/vim"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nvim_conf
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Liberatys
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-25 00:00:00.000000000 Z
+date: 2021-12-28 00:00:00.000000000 Z
 dependencies: []
 description: A ruby dsl to generate a nvim configuration
 email:
@@ -22,31 +22,50 @@ files:
 - README.md
 - bin/nvim_conf
 - lib/nvim_conf.rb
-- lib/nvim_conf/compiler_configurations/compiler_configuration.rb
-- lib/nvim_conf/compiler_configurations/manager.rb
+- lib/nvim_conf/commenter.rb
 - lib/nvim_conf/configuration_builder.rb
 - lib/nvim_conf/core.rb
+- lib/nvim_conf/generators/code/commands/lua.rb
+- lib/nvim_conf/generators/code/globals/lua.rb
 - lib/nvim_conf/generators/code/mappings/lua.rb
 - lib/nvim_conf/generators/code/mappings/vim.rb
 - lib/nvim_conf/generators/code/plugins/packer.rb
+- lib/nvim_conf/generators/code/plugins/paq.rb
+- lib/nvim_conf/generators/code/requires/lua.rb
 - lib/nvim_conf/generators/code/settings/lua.rb
 - lib/nvim_conf/generators/code/settings/vim.rb
-- lib/nvim_conf/generators/generator.rb
-- lib/nvim_conf/manager.rb
-- lib/nvim_conf/mappings/manager.rb
-- lib/nvim_conf/mappings/mapping.rb
-- lib/nvim_conf/plugins/manager.rb
-- lib/nvim_conf/plugins/plugin.rb
-- lib/nvim_conf/settings/manager.rb
-- lib/nvim_conf/settings/setting.rb
+- lib/nvim_conf/managers/commands.rb
+- lib/nvim_conf/managers/compiler_configurations.rb
+- lib/nvim_conf/managers/globals.rb
+- lib/nvim_conf/managers/mappings.rb
+- lib/nvim_conf/managers/plugins.rb
+- lib/nvim_conf/managers/requires.rb
+- lib/nvim_conf/managers/settings.rb
+- lib/nvim_conf/models/command.rb
+- lib/nvim_conf/models/compiler_configuration.rb
+- lib/nvim_conf/models/global.rb
+- lib/nvim_conf/models/mapping.rb
+- lib/nvim_conf/models/plugin.rb
+- lib/nvim_conf/models/require.rb
+- lib/nvim_conf/models/setting.rb
+- lib/nvim_conf/utils/io_operator.rb
+- lib/nvim_conf/utils/markdown_formatter.rb
 - lib/nvim_conf/version.rb
 - lib/nvim_conf/writer.rb
+- lib/nvim_conf/writers/code/commands.rb
+- lib/nvim_conf/writers/code/globals.rb
 - lib/nvim_conf/writers/code/mappings.rb
 - lib/nvim_conf/writers/code/orchestrator.rb
-- lib/nvim_conf/writers/code/plugins.rb
+- lib/nvim_conf/writers/code/plugins/configuration.rb
+- lib/nvim_conf/writers/code/plugins/handler.rb
+- lib/nvim_conf/writers/code/plugins/packer.rb
+- lib/nvim_conf/writers/code/plugins/paq.rb
+- lib/nvim_conf/writers/code/requires.rb
 - lib/nvim_conf/writers/code/settings.rb
+- lib/nvim_conf/writers/documentation/globals.rb
 - lib/nvim_conf/writers/documentation/mappings.rb
 - lib/nvim_conf/writers/documentation/orchestrator.rb
+- lib/nvim_conf/writers/documentation/plugins.rb
 - lib/nvim_conf/writers/documentation/settings.rb
 homepage: https://github.com/Liberatys/nvim_conf
 licenses:

data/lib/nvim_conf/generators/generator.rb

@@ -1,6 +0,0 @@
-module NvimConf
-  module Generators
-    class Generator
-    end
-  end
-end

data/lib/nvim_conf/manager.rb

@@ -1,6 +0,0 @@
-module NvimConf
-  class Manager
-    def store?
-    end
-  end
-end

data/lib/nvim_conf/writers/code/plugins.rb

@@ -1,86 +0,0 @@
-# TODO: This code needs to be refactored.... Bad CODE :D will be done during the addition of the second plugin manager!
-module NvimConf
-  module Writers
-    module Code
-      class PluginsWriter
-        PLUGIN_MAP = {
-          packer: NvimConf::Generators::Plugins::Code::Packer
-        }
-
-        INDENT_MAP = {
-          packer: 2
-        }
-
-        def initialize(manager, io, _params)
-          @manager = manager
-          @io = io
-        end
-
-        def write
-          send("surround_#{@manager.name}") do |plugin|
-            @io.write(
-              [
-                plugin_indent(PLUGIN_MAP[@manager.name.to_sym].new(
-                  plugin
-                ).generate),
-                "\n"
-              ].join
-            )
-          end
-        end
-
-        private
-
-        def surround_packer(&block)
-          if bootstrap?
-            @io.write(
-              <<~BOOTSTRAP
-                local fn = vim.fn
-                local install_path = fn.stdpath('data')..'/site/pack/packer/start/packer.nvim'
-                if fn.empty(fn.glob(install_path)) > 0 then
-                  packer_bootstrap = fn.system({'git', 'clone', '--depth', '1', 'https://github.com/wbthomason/packer.nvim', install_path})
-                end\n
-              BOOTSTRAP
-            )
-          end
-
-          @io.write(
-            "return require('packer').startup(function()\n"
-          )
-
-          @manager.plugins.each(&block)
-
-          if bootstrap?
-            @io.write("\n")
-            @io.write(plugin_indent(
-              <<~BOOTSTRAP
-                if packer_bootstrap then
-                    require('packer').sync()
-                  end\n
-              BOOTSTRAP
-            ))
-          end
-
-          @io.write(
-            "end)\n"
-          )
-        end
-
-        def bootstrap?
-          @manager.bootstraped
-        end
-
-        def plugin_indent(content)
-          [
-            " " * INDENT_MAP[@manager.name.to_sym],
-            content
-          ].join
-        end
-
-        def generator_class
-          PLUGIN_MAP[@manager.name.to_sym]
-        end
-      end
-    end
-  end
-end