Added mock scalar method (#155)

* Added mock scalar method

* Added docs and module for test data

* Updated dependencies

* Added security policy

.flake8

@@ -6,4 +6,5 @@ max-complexity = 10
 application-import-names = mock_alchemy,tests
 import-order-style = pep8
 docstring-convention = google
-per-file-ignores = tests/*:S101
+per-file-ignores =
+    tests/*:S101,I202

.pre-commit-config.yaml

@@ -33,12 +33,11 @@ repos:
         language: system
         types: [python]
         require_serial: true
-      - id: reorder-python-imports
+      - id: isort
         name: Reorder python imports
-        entry: reorder-python-imports
+        entry: isort
         language: system
         types: [python]
-        args: [--application-directories=src]
       - id: trailing-whitespace
         name: Trim Trailing Whitespace
         entry: trailing-whitespace-fixer

CODE_OF_CONDUCT.md

@@ -0,0 +1,164 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in
+our community a harassment-free experience for everyone, regardless of
+age, body size, visible or invisible disability, ethnicity, sex
+characteristics, gender identity and expression, level of experience,
+education, socio-economic status, nationality, personal appearance,
+race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open,
+welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our
+  mistakes, and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+- Trolling, insulting or derogatory comments, and personal or
+  political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in
+  a professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our
+standards of acceptable behavior and will take appropriate and fair
+corrective action in response to any behavior that they deem
+inappropriate, threatening, offensive, or harmful.
+
+Community leaders 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, and will
+communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also
+applies when an individual is officially representing the community in
+public spaces. Examples of representing our community include using an
+official e-mail address, posting via an official social media account,
+or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may
+be reported to the community leaders responsible for enforcement at
+[@rajivsarvepalli](https://github.com/rajivsarvepalli). All complaints will be reviewed and investigated
+promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security
+of the reporter of any incident.
+
+# Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our
+standards of acceptable behavior and will take appropriate and fair
+corrective action in response to any behavior that they deem
+inappropriate, threatening, offensive, or harmful.
+
+Community leaders 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, and will
+communicate reasons for moderation decisions when appropriate.
+
+# Scope
+
+This Code of Conduct applies within all community spaces, and also
+applies when an individual is officially representing the community in
+public spaces. Examples of representing our community include using an
+official e-mail address, posting via an official social media account,
+or acting as an appointed representative at an online or offline event.
+
+# Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may
+be reported to the community leaders responsible for enforcement at
+[@rajivsarvepalli](https://github.com/rajivsarvepalli). All complaints will be reviewed and investigated
+promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security
+of the reporter of any incident.
+
+# Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in
+determining the consequences for any action they deem in violation of
+this Code of Conduct:
+
+## 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior
+deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders,
+providing clarity around the nature of the violation and an explanation
+of why the behavior was inappropriate. A public apology may be
+requested.
+
+## 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, for a specified period of
+time. This includes avoiding interactions in community spaces as well as
+external channels like social media. Violating these terms may lead to a
+temporary or permanent ban.
+
+## 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards,
+including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No
+public or private interaction with the people involved, including
+unsolicited interaction with those enforcing the Code of Conduct, is
+allowed during this period. Violating these terms may lead to a
+permanent ban.
+
+# 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of
+individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction
+within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][],
+version 2.0, available at
+<https://www.contributor-covenant.org/version/2/0/code_of_conduct.html>.
+
+Community Impact Guidelines were inspired by [Mozilla’s code of conduct
+enforcement ladder][].
+
+For answers to common questions about this code of conduct, see the FAQ
+at <https://www.contributor-covenant.org/faq>. Translations are
+available at <https://www.contributor-covenant.org/translations>.
+
+[contributor covenant]: https://www.contributor-covenant.org
+[mozilla’s code of conduct enforcement ladder]: https://github.com/mozilla/diversity

SECURITY.md

@@ -0,0 +1,17 @@
+# Security Policy
+
+## Supported Versions
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 0.2.x   | :white_check_mark: |
+| 0.1.1   | :white_check_mark: |
+| 0.1.x   | :x:                |
+
+## Reporting a Vulnerability
+
+This library is highly unlikely to contain any vulnerabilities outside of dependency vulnerabilities
+(for which [@dependabot](https://github.com/rajivsarvepalli/mock-alchemy/security/dependabot) is scanning for).
+
+However, should you discover any vulnerabilities, please report them
+by [creating an issue](https://github.com/rajivsarvepalli/mock-alchemy/issues).

docs/conf.py

@@ -15,7 +15,7 @@
 project = "mock-alchemy"
 author = "Rajiv Sarvepalli"
 copyright = f"{datetime.now().year}, {author}"
-version = "0.2.3"
+version = "0.2.4"
 extensions = [
     "sphinx.ext.autodoc",
     "sphinx.ext.napoleon",

docs/user_guide/index.rst

@@ -122,6 +122,51 @@ session is unable to actually apply any filters so it returns everything::
    >>> session.query(Model).filter(Model.foo == 'bar').all()
    [Model(foo='bar'), Model(foo='baz')]
 
+Scalar in Sessions
+++++++++++++++++++
+You can now mock `scalar() <https://docs.sqlalchemy.org/en/14/orm/query.html#sqlalchemy.orm.Query.scalar>`__.
+The below example shows querying on a specific attribute and returning it using ``scalar()``.
+To do this you must create another object to represent the returned attribute (in this case, it is called
+``Attribute``). Scalar is then used to get the first column of the first row as shown.
+
+.. code-block:: python
+
+    from sqlalchemy import Column, String
+    from sqlalchemy.ext.declarative import declarative_base
+    from mock_alchemy.mocking import UnifiedAlchemyMagicMock
+    from unittest import mock
+
+    Base = declarative_base()
+
+    class SomeTable(Base):
+        """SQLAlchemy object representing some table."""
+        __tablename__ = "some_table"
+        pkey = Column(String, primary_key=True)
+        col1 = Column(String(50))
+
+    class SingleColumn(Base):
+        """SQLAlchemy object for mocking a query for a specific column."""
+        __tablename__ = "column"
+        col1 = Column(String(50), primary_key=True)
+
+    mock_session = UnifiedAlchemyMagicMock(
+        data=[
+            (
+                [
+                    mock.call.query(SomeTable.col1),
+                    mock.call.filter(SomeTable.pkey == 3),
+                ],
+                [SingleColumn(col1="test")],
+            )
+        ]
+    )
+    found_col1 = (
+        mock_session.query(SomeTable.col1)
+        .filter(SomeTable.pkey == 3)
+        .scalar()
+    )
+    assert found_col1 == "test"
+
 Deleting in Sessions
 ++++++++++++++++++++
 
@@ -445,6 +490,9 @@ for specific objects being present and ensure their values are correct and still
         anyalsis3 = session.query(CombinedAnalysis).get({"pk1": 3})
         assert anyalsis3 == expected_anyalsis3
 
+
+
+
 Abstract Classes
 ^^^^^^^^^^^^^^^^