ella 0.1.2

data/lib/ella/server.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+require_relative 'pipeline'
+
+module Ella
+  # This is not so much a server as a something which starts of the server and
+  # various listeners and initializers associated with Ella. From the point of
+  # view of the rest of Ella, this will be the server, though.
+  # This also restarts the server in development mode, something Sinatra is a
+  # bit shifty about on its own, due to Ruby restrictions.
+  class Server
+    def initialize(mode: 'development', port: nil)
+      Ella.find_root
+      Log.yell("Starting server in #{mode} mode...")
+      @mode = mode
+      @port = port
+
+      establish_pipelines
+    end
+
+    def run
+      Ella.find_root
+      @mode_path = File.join(Dir.pwd, 'temp/mode')
+      File.open(@mode_path, 'w') { |f| f.puts(@mode) }
+      RackfileGenerator.new.run
+
+      Log.info('Staring Puma...')
+      @mode == 'production' ? start_production_server : start_development_listener_loop
+    end
+
+    def css_path
+      @pipelines[:css].path
+    end
+
+    def js_path
+      @pipelines[:js].path
+    end
+
+    private
+
+    def start_production_server
+      system("puma #{"-p #{@port}" if @port} -e #{@mode} -C \"configs/puma.rb\" rack.ru", out: $stdout, err: :out)
+    end
+
+    # As the name implies, it is necessary to keep the program idling while in
+    # development, in order have the listeners contiue to run.
+    def keep_listeners_alive
+      sleep
+    rescue Interrupt
+      sleep 1
+      File.delete(@mode_path) if File.exist?(@mode_path)
+      Log.exit_message('Ella is shutting down. Moimoi.')
+    end
+
+    # This restarts the actual puma server, but not Ella's listerners, which
+    # remain running. Sinatra's reloader only works for files that exist when
+    # the server started. To my knowledge this has to be the case.
+    # See Puma documentation on SIGUSR2 for more info.
+    def restart
+      mode = File.open(File.join(Dir.pwd, 'temp/mode')).read.chomp
+      if mode == 'development'
+        RackfileGenerator.new.run
+        pid = File.open(File.join(Dir.pwd, 'temp/puma.pid')).read.to_i
+        Process.kill('SIGUSR2', pid)
+      end
+    end
+
+    # Modified is handled by Sinatra reloader, if anything because the console
+    # output is less spammy.
+    def start_model_controller_listeners
+      input_dirs = [File.join(Dir.pwd, 'controllers'), File.join(Dir.pwd, 'models')]
+      @listener = Listen.to(*input_dirs) do |modified, added, removed|
+        restart if !added.empty? || !removed.empty?
+      rescue => e
+        # You never know with listen.
+        puts e
+      end
+      @listener.start
+    end
+
+    def start_development_listener_loop
+      start_development_server
+      start_model_controller_listeners
+      keep_listeners_alive
+    end
+
+    # Do not refactor unless you are 100% sure you are comfortable with Ruby forking.
+    def start_development_server
+      unless @pid = fork
+        exec("puma #{"-p #{@port}" if @port} -e #{@mode} -C \"configs/puma.rb\" rack.ru", out: $stdout, err: :out)
+      end
+    end
+
+    def establish_pipelines
+      @pipelines = { css: Pipeline.new('css'), js: Pipeline.new('js') }
+      # Listener runs pipeline in development, otherwise, the pipeline runs once
+      # before starting the server.
+      if @mode == 'development'
+        Log.info('Starting pipeline listeners...')
+        @pipelines.map { |_, v| v.listen }
+      else
+        Log.info('Precompiling assets...')
+        @pipelines.map { |_, v| v.run }
+      end
+    end
+  end
+end

data/lib/ella/template.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'erb'
+
+module Ella
+  # Class to handle naming, copying, and processing the various templates that
+  # the Ella generators use.
+  class Template
+    TEMPLATE_DIRECTORY = File.expand_path('../../templates', __dir__)
+
+    # If generic_template is nil, this class will look for a specific template based on the filename.
+    def initialize(filename, generic_template: nil, template_vars: nil)
+      @filename = filename
+      @destination = File.join(Dir.pwd, @filename)
+      @generic_template = generic_template
+      @template_vars = template_vars
+    end
+
+    def write
+      Log.create(@filename)
+      if file_exists?
+        Log.error('File already exists. Skipping.')
+      else
+        File.open(@destination, 'w') { |f| f.write(data) }
+      end
+    end
+
+    private
+
+    def file_exists?
+      File.exist?(@destination)
+    end
+
+    def render_erb(template)
+      @template_vars ? ERB.new(template, nil, '-').result_with_hash(@template_vars) : template
+    end
+
+    def template_path
+      File.join(TEMPLATE_DIRECTORY, @generic_template || @filename)
+    end
+
+    def data
+      @generic_template == :blank ? '' : render_erb(File.open(template_path, 'r').read)
+    end
+  end
+end

data/lib/ella/test.rb

@@ -0,0 +1,9 @@
+module Ella
+  # Runs tests for user project. Currently default to RSpec.
+  class Test
+    def self.run
+      Ella.find_root
+      exec('rspec -P "tests/*.rb, tests/*/*.rb"')
+    end
+  end
+end

data/lib/ella/version.rb

@@ -0,0 +1,3 @@
+module Ella
+  VERSION = '0.1.2'
+end

data/templates/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+ruby '2.7.2'
+
+gem 'puma', '~>5.0'
+gem 'sinatra', '~>2.1'
+
+gem 'colorize', '~>0.8'
+gem 'listen', '~>3.3'
+gem 'rspec', '~>3.1'

data/templates/configs/css.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# This is the assets pipeline for CSS. See the documentation for more info. Kill time.
+module Ella
+  class Pipeline
+    def css
+      # Welcome to your CSS filter! Everything here will be outputted into a
+      # single file, whose path is available by running the method "css_path",
+      # which can be called from a view.
+
+      # The method 'asset_data(*file_names)' will return the data for all files
+      # that are in the relevant assets directory. For CSS that is "assets/css/"
+
+      # A quick and dirty example of how you might call Sass here:
+      # require 'sassc'
+      # raw_data = asset_data('main.scss', 'other_file.scss')
+      # SassC::Engine.new(raw_data, style: :compressed).render
+    end
+  end
+end

data/templates/configs/js.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# This is the assets pipeline for Javascript. See the documentation for more info. Kill time.
+module Ella
+  class Pipeline
+    def js
+      # Welcome to your Javascript filter! Everything here will be outputted into
+      # a single file, whose path is available by running the method "js_path",
+      # which can be called from a view.
+
+      # The method 'asset_data(*file_names)' will return the data for all files
+      # that are in the relevant assets directory. For JS that is "assets/js/"
+
+      # A quick and dirty example of how use might implement a simple minifier:
+      # raw_data = asset_data('main.js', 'other_file.js')
+      # raw_data.gsub("\n", '')
+    end
+  end
+end

data/templates/configs/puma.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+# Puma configuration file.
+bind 'tcp://localhost:7654'
+pidfile File.join(__dir__, '../temp/puma.pid')

data/templates/controller

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class <%= name.pascal_case %>Controller < Ella::Controller
+<% files.each_with_index do |f, i| -%>
+  get '/<%= name.snake_case %>/<%= f %>' do
+    erb :'<%= name.snake_case %>/<%= f %>'
+  end<%= "\n" if i != files.length - 1 %>
+<% end -%>
+end

data/templates/controllers/root.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class RootController < Ella::Controller
+  get '/' do
+    erb :'root/index'
+  end
+end

data/templates/main.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# You can put any code you like in this file and it will load when you run the
+# server.
+# The Ella server depends on this file existing in the root directory, so please
+# do not remove or delete it.
+class <%= name.pascal_case %> < Ella::Controller
+end

data/templates/model

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+class <%= name.pascal_case %>
+  # This class will be accessable from your controllers. If you are looking for
+  # an ORM, try the 'sequel' package.
+end

data/templates/test

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'ella'
+require_relative '../../controllers/<%= name.snake_case %>'
+
+# Test file for <%= name.pascal_case %>.
+# See RSpec documentation for more into.
+RSpec.describe <%= name.pascal_case + 'Controller' if @controller %> do
+  before(:all) do
+  end
+
+  it 'knows what true is' do
+    expect(true).to be true
+  end
+
+  it 'knows what false is' do
+    expect(false).to be true
+  end
+
+  after (:all) do
+  end
+end

data/templates/views/layout.erb

@@ -0,0 +1,18 @@
+<!doctype html>
+
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+
+    <title><%= name.human %></title>
+    <meta name="description" content="FILL ME IN!">
+    <meta name="author" content="FILL ME IN!">
+
+    <link rel="stylesheet" href="<%%= css_path %>">
+  </head>
+
+  <body>
+    <%%= yield %>
+    <script src="<%%= js_path %>"></script>
+  </body>
+</html>

data/templates/views/root/index.erb

@@ -0,0 +1,3 @@
+<h1>Welcome to Ella!</h1>
+
+<p>This is the root page of your new project. Feel free to change everything.</p>

data/version.txt

@@ -0,0 +1 @@
+0.1.0

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: ella
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Kyle Church
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-11-27 00:00:00.000000000 Z
+dependencies: []
+description: Ella is a web framework which seeks which seeks to find a balance between
+  the simplicity of a microframework and the conveniences of a large, opinionated
+  framework. Ella uses Sinatra for its controllers and routing.
+email:
+- kyle@kylechur.ch
+executables:
+- ella
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- ella-0.1.0.gem
+- ella.gemspec
+- exe/ella
+- lib/ella.rb
+- lib/ella/cli.rb
+- lib/ella/controller.rb
+- lib/ella/generator.rb
+- lib/ella/generator/config_generator.rb
+- lib/ella/generator/controller_generator.rb
+- lib/ella/generator/destroyer.rb
+- lib/ella/generator/gemfile_generator.rb
+- lib/ella/generator/model_generator.rb
+- lib/ella/generator/project_generator.rb
+- lib/ella/generator/rackfile_generator.rb
+- lib/ella/generator/view_generator.rb
+- lib/ella/log.rb
+- lib/ella/model.rb
+- lib/ella/name_formatter.rb
+- lib/ella/pipeline.rb
+- lib/ella/reloader.rb
+- lib/ella/server.rb
+- lib/ella/template.rb
+- lib/ella/test.rb
+- lib/ella/version.rb
+- lib/ella/view.rb
+- templates/Gemfile
+- templates/configs/css.rb
+- templates/configs/js.rb
+- templates/configs/puma.rb
+- templates/controller
+- templates/controllers/root.rb
+- templates/main.rb
+- templates/model
+- templates/test
+- templates/views/layout.erb
+- templates/views/root/index.erb
+- version.txt
+homepage: https://bitbucket.org/SurdEgg/ella/src/master/
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://bitbucket.org/SurdEgg/ella/src/master/
+  source_code_uri: https://bitbucket.org/SurdEgg/ella/src/master/
+  changelog_uri: https://bitbucket.org/SurdEgg/ella/src/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: A convenience-focused mesoframework for web development.
+test_files: []