ella 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 69b651c073b90ba525900d545f69fc444d33e373921c50e43fe276e37cc3e0f6
+  data.tar.gz: 0625fcaf0b4800b3bf016c733443395bf0f1aba5155a62cf14f7274c31bcc5e6
+SHA512:
+  metadata.gz: ba92e4f9896b93c7e96bdb6151e2f92c1e2bc51d2417ae7ba010d49a2a3f2ed05301119d0f3852a223efb462bc1adfc0e83fdb939fcbff4c77e53a8e89ec4d73
+  data.tar.gz: 1d49e9b5e025287b6a3cfd86fdfa9ddfc90b9dfec0b5247d946309dddfcfdf063e15b89c39f3d40719336e8a750a38398e0055c59eee13b9a36812db8325f855

data/.gitignore

@@ -0,0 +1,7 @@
+# swap files
+*.swp
+
+# Temp and misc
+temp
+TODO
+tmp/

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## [0.1.0] - 2020-11-27
+### GENERAL
+- Initial beta release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at kyle@kylechur.ch. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,56 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    colorize (0.8.1)
+    diff-lcs (1.4.4)
+    ffi (1.13.1)
+    listen (3.3.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    mustermann (1.1.1)
+      ruby2_keywords (~> 0.0.1)
+    nio4r (2.5.4)
+    puma (5.0.4)
+      nio4r (~> 2.0)
+    rack (2.2.3)
+    rack-protection (2.1.0)
+      rack
+    rb-fsevent (0.10.4)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    ruby2_keywords (0.0.2)
+    sinatra (2.1.0)
+      mustermann (~> 1.0)
+      rack (~> 2.2)
+      rack-protection (= 2.1.0)
+      tilt (~> 2.0)
+    tilt (2.0.10)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  colorize (~> 0.8)
+  listen (~> 3.3)
+  puma (~> 5.0)
+  rspec (~> 3.1)
+  sinatra (~> 2.1)
+
+RUBY VERSION
+   ruby 2.7.2p137
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Kyle Church
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,115 @@
+# Ella
+
+Ella is a backend web framework using [Ruby](https://www.ruby-lang.org/en/), [Sinatra](http://sinatrarb.com/), [Puma](https://puma.io/), and [Rack](https://github.com/rack/rack). The basic goal is to have some of the basic conveniences of RoR, but cleaner, smaller, more flexible, and with minimal depencies.
+
+Ella is still in early beta, so there are still a few things to work out!
+
+## Table of Contents
+
+* [Ella](#markdown-header-ella)
+	* [Table of Contents](#markdown-header-table-of-contents)
+	* [Hello World - Simple](#markdown-header-hello-world)
+	* [Hello World - Build a Blog](#markdown-build-a-blog)
+	* [Docs](#markdown-header-docs)
+
+## Hello World
+
+Doing this will give you a basic web app on port 7654:
+
+```shell
+ella new foo
+cd foo
+ella s
+```
+
+## Build A Blog
+
+Just a simple blog to get an idea of how to use Ella:
+
+```shell
+ella new test-blog
+cd test-blog
+ella mvc user index show new destroy
+ella mvc post index show new destroy
+```
+This will create the appropriate files and routes for models, views, and controllers. The actual implementation is up to you, the developer. While this is not as convenient as RoR, it is easier to learn and much more flexible. The primary inspiration for Ella was that very few real-world projects fit the exact RoR model, which requires a lot of ugly hacking to get around.
+
+To pass things from a controller to a view, use instance variables:
+
+```ruby
+# models/foo.rb
+class Foo
+  def some_method
+    'Hello World!'
+  end
+end
+```
+
+```ruby
+# controllers/foo.rb
+get '/foo/new' do
+  @this_foo = Foo.new
+end
+```
+
+```ruby
+# views/foo/new.erb
+<p><%= @this_foo.some_method %></p>
+```
+
+Routing is handled by the controllers, and is taken directly from Sinatra. See the [Sinatra documentation](http://sinatrarb.com/intro.html) for more info.
+
+Ella does not feature an ORM, but an plugin is in the works. In the meantime, try [Sequel](https://github.com/jeremyevans/sequel).
+
+## Docs
+
+To get help:
+
+```shell
+ella h
+```
+
+To create a new project:
+
+```shell
+ella new (project name)
+```
+
+To run a server:
+
+```shell
+ella s (optional: development/production) (optional: port number)
+```
+The port can also be set in config/puma.rb
+
+To create a new controller:
+
+```shell
+ella c (controller name) (optional: route names)
+```
+
+To create a new model:
+
+```shell
+ella m (model name) (optional: route names)
+```
+
+To create a new view subdirectory:
+
+```shell
+ella v (view name) (optional: route names)
+```
+
+These can be combined, although a controller is necessary for routing. The following example will just create the controller and the view:
+
+```shell
+ella cv foo
+```
+
+The css/js pipelines are configured in the "config/" directory, and the assets themselves can be found in the "assets/" directory. The assets config files have more detailed explanations in the comments.
+
+Ella uses RSpec for tests. To run your test suite:
+
+```shell
+ella t
+```

data/ella.gemspec

@@ -0,0 +1,26 @@
+require_relative 'lib/ella/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ella"
+  spec.version       = Ella::VERSION
+  spec.authors       = ["Kyle Church"]
+  spec.email         = ["kyle@kylechur.ch"]
+  spec.summary       = %q{A convenience-focused mesoframework for web development.}
+  spec.description   = %q{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.}
+  spec.homepage      = "https://bitbucket.org/SurdEgg/ella/src/master/"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://bitbucket.org/SurdEgg/ella/src/master/"
+  spec.metadata["changelog_uri"] = "https://bitbucket.org/SurdEgg/ella/src/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/exe/ella

@@ -0,0 +1,14 @@
+#! /usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift("#{__dir__}/../lib")
+
+require 'ella'
+
+# This is the executable that the user will use Ella through. Ideally, this
+# should be completely replaceable without having to change ella.rb.
+module Ella
+  version = File.open(File.join(__dir__, '../version.txt')).read.chomp
+  Log.yell("Ella v.#{version}")
+  CLI.new(ARGV)
+end

data/lib/ella.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'listen'
+
+require_relative 'ella/log'
+require_relative 'ella/name_formatter'
+
+require_relative 'ella/generator'
+require_relative 'ella/generator/project_generator'
+require_relative 'ella/generator/model_generator'
+require_relative 'ella/generator/view_generator'
+require_relative 'ella/generator/controller_generator'
+require_relative 'ella/generator/gemfile_generator'
+require_relative 'ella/generator/config_generator'
+require_relative 'ella/generator/rackfile_generator'
+require_relative 'ella/generator/destroyer'
+
+require_relative 'ella/template'
+require_relative 'ella/controller'
+require_relative 'ella/test'
+require_relative 'ella/server'
+require_relative 'ella/cli'
+
+# The main module for the Ella framework-framework.
+module Ella
+  # This custom function exists because, ideally, the program will always abort
+  # with a logged message.
+  def self.abort(message)
+    Log.error(message)
+    Kernel.abort
+  end
+
+  # Most of what Ella does requires a valid Ella project, however, the user
+  # could potentially be in a subdirectory.
+  def self.find_root
+    until Dir.entries(Dir.pwd).include?('main.rb')
+      if Dir.pwd == '/'
+        puts 'Error! This is not a valid Ella project directory!'
+        exit!
+      else
+        Dir.chdir('..')
+      end
+    end
+  end
+end

data/lib/ella/cli.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+module Ella
+  # The code for handling command-line arguments was getting complicated and
+  # ugly, so now it is a class.
+  # This is the least-integral part of Ella, and everything here should be
+  # replaceable without having to change the non-static classes.
+  class CLI
+    def initialize(args)
+      @args = args
+      @errors = []
+
+      try_no_args
+      try_help
+      try_new_project
+      try_mvc
+      try_destroy
+      try_server
+      try_test
+
+      exit_with_help('Ella does not understand your command.')
+    end
+
+    private
+
+    def try_no_args
+      return unless @args[0].nil?
+
+      exit_with_help('No arguments given.')
+    end
+
+    def try_help
+      return unless ['h', 'help', '?'].include?(@args[0])
+
+      exit_with_help(nil)
+    end
+
+    def try_new_project
+      return unless ['n', 'new'].include?(@args[0])
+
+      exit_with_help('You need to give your project a name.') if @args[1].nil?
+      ProjectGenerator.new(directory: @args[1]).run
+      exit
+    end
+
+    def try_mvc
+      return unless @args[0] =~ /^[mvc]*$/
+
+      ModelGenerator.new(directory: @args[1]).run if @args[0] =~ /m/
+      ViewGenerator.new(directory: @args[1], files: @args[2..-1]).run if @args[0] =~ /v/
+      ControllerGenerator.new(directory: @args[1], files: @args[2..-1]).run if @args[0] =~ /c/
+      exit
+    end
+
+    def try_destroy
+      return unless ['d', 'destroy'].include?(@args[0])
+
+      Destroyer.new(directory: @args[1]).run
+      exit
+    end
+
+    def try_server
+      return unless ['s', 'server', 'r', 'run'].include?(@args[0])
+
+      Server.new(mode: @args[1] || 'development', port: @args[2]).run
+      exit
+    end
+
+    def try_test
+      return unless ['t', 'test'].include?(@args[0])
+
+      Test.run
+      exit
+    end
+
+    def exit_with_help(message)
+      Log.error(message) if message
+      print_help
+      exit
+    end
+
+    def print_help
+      puts <<~HELP
+      -------------------
+      |   Ella - Help   |
+      -------------------
+
+      To create a new project:
+          > ella new (project name)
+
+      To run a server:
+          > ella s
+
+      To create a new controller:
+          > ella c (controller name)
+
+      To create a new model:
+          > ella m (model name)
+
+      To create a new view subdirectory:
+          > ella v (view name)
+
+      To create a view in a subdirectory:
+          > ella v foo bar # (saves to views/foo/bar.erb)
+
+      The model, view, and controller commands can be combined:
+          > ella mvc blog_post
+
+      To run tests:
+          > ella t
+      HELP
+    end
+  end
+end